Re: [jamboost] Bugs/Moratorium

From: David Abrahams (david.abrahams_at_[hidden])
Date: 2002-03-26 22:54:48

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

> I'm all for having the system include "online" help, hooray :-) And my
> previous mention of in-code documentation seems like something we can
do to
> provide that. A model we can look at is the Perl doc system. It has
the same
> problems as we have, incremental, and highly modular code. And it
manages to
> provide documentation for all of it.

I don't know that jam is as amenable to this sort of thing, though...
hmm, HDRRULE, anyone? Maybe there is a way to extract doc from comments
after all. Hmm, doctest anyone? Now I'm starting to scare myself...

> So maybe a few rules that provide documentation in the form of long,
short,
> and brief. We can tie this either to modules or rule, or both. And
then it
> becomes possible to provide the "bjam --help-<module/rule-name>"
> functionality.

Well, let's be sure to pick something reasonably achievable, please, or
nobody will write docs OR code! This sounds like a bit more of a
challenge than I'd be ready to take on...

-Dave