Thread: [ooc-compiler] Why are parameter comments removed?

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Hello all,

When generating documentation with oo2c, parameter comments like in e.g.

    PROCEDURE P(VAR (*in*) a: ARRAY OF LONGINT);

are removed. Why?

August

On 10/10/05, August Karlstrom <fus...@co...> wrote:
> Hello all,
>
> When generating documentation with oo2c, parameter comments like in e.g.
>
>     PROCEDURE P(VAR (*in*) a: ARRAY OF LONGINT);
>
> are removed. Why?

Mh, I do not understand the question.  Documentation, like the output of oo=
b, is
generated from the symbol file.  The compiler discards comments at a very e=
arly
stage, way before the symbol file is generated.

-- mva

Michael van Acken wrote:
> On 10/10/05, August Karlstrom <fus...@co...> wrote:
>>When generating documentation with oo2c, parameter comments like in e.g.
>>
>>    PROCEDURE P(VAR (*in*) a: ARRAY OF LONGINT);
>>
>>are removed. Why?
> 
> Mh, I do not understand the question.  Documentation, like the output of oob, is
> generated from the symbol file.  The compiler discards comments at a very early
> stage, way before the symbol file is generated.

Comments like (*in*) and (*out*) seems to be common practice in ETH 
Oberon as a part of the module interface documentation, see e.g.

    http://www.oberon.ethz.ch/ethoberon/defs/Strings.Def.html

Just by looking at the procedure signature you know the purpose of VAR.

August

> Comments like (*in*) and (*out*) seems to be common practice in ETH
> Oberon as a part of the module interface documentation, see e.g.
>
>     http://www.oberon.ethz.ch/ethoberon/defs/Strings.Def.html
>
> Just by looking at the procedure signature you know the purpose of VAR.

They must have introduced this after my acquaintance with ETH Oberon.
I have never seen this, nor used it.

-- mva