Re: [jamboost] Doc/Help

From: Rene Rivera (grafik666_at_[hidden])
Date: 2002-04-11 09:06:13

On 2002-04-11 at 08:32 AM, david.abrahams_at_[hidden] (David Abrahams) wrote:

>
>----- Original Message -----
>From: "Rene Rivera" <grafik666_at_[hidden]>
>
>> Actually what I'll do is pick out individual comment chunks, a bunch
>of
>> "#"'s in a row. Then if I notice it's a (C) one remember that,
>otherwise
>> take it as the module doc. That way when we print html we can print
>the (C)
>> info also :-)
>
>As long as there's an easy way to write implementation docs which don't
>show up in the user-level help...

Yes.... some psuedocode...

1. implicitly enter file module scope, current comment scope is module
2. read comment block
3. is it (C), remember it as the (C) for the module. goto #2
4. otherwise set it as the doc for the module.
5. read comment block
6. read next jam syntax
7. if it's a rule, set previous comment block to doc of rule. enter rule
scope. goto #5.
8. if it's a var, set prev. to doc of var. goto #5.
9. if it's an arg, and we are at rule scope, set arg doc. goto #5.
10. if it's a module, goto #2.

I'm sure I missed something there, but you get the idea. [Replace the gotos
with appropriate loop constructs :-)]

-- grafik - Don't Assume Anything
-- rrivera_at_[hidden] - grafik_at_[hidden]
-- 102708583_at_icq - Grafik666_at_AIM - Grafik_at_[hidden]