[LinuxBIOS] #23: Use Doxygen-style comments
LinuxBIOS
svn at openbios.org
Fri Nov 3 12:14:14 CET 2006
#23: Use Doxygen-style comments
-----------------------------+----------------------------------------------
Reporter: uwe | Owner: somebody
Type: enhancement | Status: new
Priority: minor | Milestone: Cosmetic fixes
Component: code | Version: v2
Resolution: | Keywords:
Include_gantt: 0 | Dependencies:
Due_assign: MM/DD/YYYY | Due_close: MM/DD/YYYY
-----------------------------+----------------------------------------------
Comment (by uwe):
Replying to [comment:1 stepan]:
> > We should probably use Doxygen-style comments to document (at least)
the core API/code of LinuxBIOS.
>
> This documentation is automatically available at:
>
> http://qa.linuxbios.org/docs/doxygen.php
>
> It does not cover the romcc compiled parts though. Should we bother?
No, probably not. But I was referring to actually documenting the code. I
know that the doxygen output is already available, but as there's very few
comments (and none which have doxygen-syntax) the doxygen output is only
of limited use.
--
Ticket URL: <http://tracker.linuxbios.org/trac/LinuxBIOS/ticket/23#comment:2>
LinuxBIOS <http://www.linuxbios.org/>
More information about the coreboot
mailing list