erebion/coreboot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document how to generate the Doxygen documentation for LinuxBIOS (trivial).

Browse source 
Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>
Acked-by: Uwe Hermann <uwe@hermann-uwe.de>



git-svn-id: svn://coreboot.org/repository/LinuxBIOSv3@299 f3766cd6-281f-0410-b1cd-43a5c92072e9
This commit is contained in:
Uwe Hermann 2007-05-02 13:06:05 +00:00
commit 970c4059dc
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
HACKING
View file

@ -8,6 +8,31 @@ Development Guidelines
Please read http://linuxbios.org/Development_Guidelines.
Doxygen-generated Code/API Documentation
----------------------------------------
The source code of LinuxBIOS is documented using Doxygen-style code comments.
The Doxygen tool can generate HTML API documentation out of these comments.
You can generate this documentation via:
make doxy
The documentation will be stored in the doxygen/html directory.
The generation of the documentation takes ca. 1-2 minutes, and may require
more than 30 MB of space on the hard drive, depending on the options
selected in the Doxygen config file, util/doxygen/Doxyfile.LinuxBIOS.
Required software:
* Doxygen (tested with Doxgen 1.5.1)
http://www.doxygen.org/
* dot (>= 1.8.10)
http://www.graphviz.org/
Third-party Code and License Overview
-------------------------------------