From 970c4059dc87b0723d5c7ac08d4cfca80b706489 Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Wed, 2 May 2007 13:06:05 +0000 Subject: [PATCH] Document how to generate the Doxygen documentation for LinuxBIOS (trivial). Signed-off-by: Uwe Hermann Acked-by: Uwe Hermann git-svn-id: svn://coreboot.org/repository/LinuxBIOSv3@299 f3766cd6-281f-0410-b1cd-43a5c92072e9 --- HACKING | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/HACKING b/HACKING index c41ee7fecb..d6ab5326a9 100644 --- a/HACKING +++ b/HACKING @@ -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 -------------------------------------