Date: Mon, 14 Jul 2008 11:15:14 +0200
From: Alexander Leidinger <Alexander@Leidinger.net>
To: Mel <fbsd.hackers@rachie.is-a-geek.net>
Cc: freebsd-hackers@freebsd.org
Subject: Re: Kernel API docs ('make doxygen')
Message-ID: <20080714111514.3394138okvgiq42o@webmail.leidinger.net>
In-Reply-To: <200807111517.54399.fbsd.hackers@rachie.is-a-geek.net>
References: <200807111517.54399.fbsd.hackers@rachie.is-a-geek.net>
next in thread | previous in thread | raw e-mail | index | archive | help
Quoting Mel <fbsd.hackers@rachie.is-a-geek.net> (from Fri, 11 Jul 2008 15:17:54 +0200): > I was wondering if this project is considered obsolete, finished or work in > progress. I would say it's in the "it has to prove it's usefulness"-stage. This means not all people are convinced it is useful to have such stuff in our source and someone needs to sit down and do something good to a subsystem to show that it is useful to those people. > If it's the latter, I'm happy to do the legwork, like set up proper stubs for > each function and structure that people who really know how they work can I think some people would complain if this would be committed to our version control system without consent, and without those stubs being there I don't expect that the stubs get converted to proper docs. So giving advice to just go ahead may be a waste. > adjust. There's a lot already in there with normal comments, that can become > documentation by simply adding an extra asterisk. Decide for yourself if you are willing to invest your time to convert the existing docs in the source into doxygen docs. In src/tools/kerneldoc/subsys/ is already a framework to handle the doxygen stuff per subsystem (not all subsystems are done there). It would be most beneficial to start with one of the subsystems which are already available there. In case you want to play around there, send me a mail and I try to get some time to commit some fixes. In case you are interested to work on a subsystem which is not represented there, you can email me too (but it should be easy to copy&modify an existing file). But again, no guarantees that any changes to the source get's committed. Bye, Alexander. -- Beware of a tall black man with one blond shoe. http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID = B0063FE7 http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID = 72077137
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20080714111514.3394138okvgiq42o>