Boost logo

Boost-Build :

From: David Abrahams (david.abrahams_at_[hidden])
Date: 2002-04-09 19:19:21

----- Original Message -----
From: "Rene Rivera" <grafik666_at_[hidden]>
> >
> >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 figured you'd suggest that ;-] I typed that and then changed it
because I
> realized that it would be easier to code when the comment is always
> the item.

...hee hee; that you typed it my way first should tell you something.

> >I think we may need something like my previous suggestion eventually,
> >for when argument documentation grows large. But let's cross that
> >when we come to it.
> Like in Doxygen & Javadoc, argument documentation should NOT grow too
> If it does then you should put it as part of the regular comment,
> in a good prose style!

Agreed. Anyway, if we find we /need/ another style, we can add it. For
now, though, we're all set.

> ...I suggest we start using that style of docs now! I'll put the
effort into
> doc.jam to parse it. But not until the weekend.

Fabulous! I'm on board!



Boost-Build list run by bdawes at, david.abrahams at, gregod at, cpdaniel at, john at