Re: [jamboost] Doc/Help

From: David Abrahams (david.abrahams_at_[hidden])
Date: 2002-04-09 18:37:16

----- Original Message -----
From: "Rene Rivera" <grafik666_at_[hidden]>

> Well, since we are talking terse, then the obvious minimalist syntax
would
> be...
>
> # Specifies the documentation for a rule in the current module.
> # If called in the global module, this documents a global rule.
> #
> rule document-rule (
> # The name of the rule.
> name :
> # The documentation for the rule.
> docs +
> )
> {
> ...
> }
>
> Also seems the most direct and to the point. If I remember correctly
this is
> similar to Lisp docs.

Yes! As long as I can write it:

# Specifies the documentation for a rule in the current module.
# If called in the global module, this documents a global rule.
rule document-rule (
name # The name of the rule.
: docs + # The documentation for the rule.
)
{
...
}

I think we may need something like my previous suggestion eventually,
for when argument documentation grows large. But let's cross that bridge
when we come to it.

-Dave