lkml.org 
[lkml]   [2006]   [Feb]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: RFC: more documentation in source files
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
[unhandled content-type:application/pgp-signature]
\
 
 \ /
  Last update: 2006-02-17 08:40    [W:0.049 / U:0.516 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site