From: Joshua Nichols <nichoj@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: Re: [gentoo-dev] merging man page documentation into eclasses
Date: Mon, 11 Jun 2007 08:41:27 -0400 [thread overview]
Message-ID: <466D42F7.5030400@gentoo.org> (raw)
In-Reply-To: <200706110205.01904.vapier@gentoo.org>
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
next prev parent reply other threads:[~2007-06-11 12:43 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-06-11 6:05 [gentoo-dev] merging man page documentation into eclasses Mike Frysinger
2007-06-11 6:40 ` Andrew Ross
2007-06-11 12:41 ` Joshua Nichols [this message]
2007-06-18 0:19 ` Mike Frysinger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=466D42F7.5030400@gentoo.org \
--to=nichoj@gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox