[augeas-devel] Lenses documentation

David Lutterkort lutter at redhat.com
Fri Sep 5 17:12:05 UTC 2008


On Fri, 2008-09-05 at 08:36 +0200, Raphaël Pinson wrote:
> Hi all,
> 
> I made some basic tests yesterday with NaturalDocs.
> 
> The modified files can be found on [0], the conf for NaturalDocs is at
> [1] and the generated doc is at [2].
> 
> 
> The down side of this currently is that the comments repeat the
> contents of the code, which make it a bit heavy to document. Ideally,
> I would like to make a Perl Module for NaturalDocs to enhance the
> Augeas language support, in order to parse the files for definitions,
> and only add comments for what is not explicit yet.

Just to repeat what I said on IRC yesterday: this is excellent, and will
make it much easier for people to browse and see what Augeas supports;
and, as Raphael said, the more that can be generated without special
comments, the better.

David





More information about the augeas-devel mailing list