From: Martin Waitz <tali@admingilde.org>
To: Greg KH <greg@kroah.com>
Cc: linux-kernel@vger.kernel.org
Subject: Re: RFC: more documentation in source files
Date: Fri, 17 Feb 2006 08:37:41 +0100 [thread overview]
Message-ID: <20060217073741.GB5517@admingilde.org> (raw)
In-Reply-To: <20060216224346.GA17190@kroah.com>
[-- Attachment #1: Type: text/plain, Size: 1098 bytes --]
hoi :)
On Thu, Feb 16, 2006 at 02:43:46PM -0800, Greg KH wrote:
> What's wrong with just extending kerneldoc in the ways that you feel it
> would be more powerful?
nothing wrong with that, only a lot of work ;-)
> What specifically do you feel is lacking in kerneldoc that doxygen
> provides?
* it automatically links all structures / function calls in the text
to their detailed description.
* it can put descriptive, structured text on one page with
code documentation.
* section hierarchy can be defined in the source files by assigning
documentation blocks to "groups".
* It's already there.
Most of these things won't be too hard to implement, but nethertheless
it will take some time. I really don't want to reinvent the wheel.
Well, I'm not really fixed on doxygen, I just wanted to experiment
with other documentation systems to see what they can provide.
If someone can recommend a good one - fine.
If we write it ourself - fine, too.
But I don't want to start extending kernel-doc before taking a look
on alternatives.
--
Martin Waitz
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 189 bytes --]
prev parent reply other threads:[~2006-02-17 7:37 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-02-16 21:40 RFC: more documentation in source files Martin Waitz
2006-02-16 22:43 ` Greg KH
2006-02-17 7:37 ` Martin Waitz [this message]
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=20060217073741.GB5517@admingilde.org \
--to=tali@admingilde.org \
--cc=greg@kroah.com \
--cc=linux-kernel@vger.kernel.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