Mailing List Archive

Mike Frysinger wrote:
> keeping documentation of functions in a separate file (man pages in this case)
> has obvious bit rot problems written all over it, so i'd like to merge the
> documentation into the respective eclasses so that the man pages can be
> automatically generated

+1

Of course, I always use the eclass itself for reference (since not all
eclasses have man pages).

Cheers

Andrew

Mike Frysinger wrote:
> keeping documentation of functions in a separate file (man pages in this case)
> has obvious bit rot problems written all over it, so i'd like to merge the
> documentation into the respective eclasses so that the man pages can be
> automatically generated
>

For the Java eclasses, we've been marking them up with something akin to
javadoc. We never did get around to writting something that actually
parses it though, but I wouldn't imagine it to be difficult.

See java-utils-2.eclass for what it looks like.

--
Joshua Nichols
Gentoo/Java Secondary Project Lead
Gentoo/Xfce Project Lead
Gentoo/Ruby Developer

--
gentoo-dev@gentoo.org mailing list

On Monday 11 June 2007, Mike Frysinger wrote:
> keeping documentation of functions in a separate file (man pages in this
> case) has obvious bit rot problems written all over it, so i'd like to
> merge the documentation into the respective eclasses so that the man pages
> can be automatically generated

ive added docs to eutils.eclass and you can find the awk script in
app-portage/eclass-manpages/files/eclass-to-manpage.awk for people who want
to review
-mike