Ginger88895
/
warzone2100
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move the mainpage for the Doxygen documentation from src/main.c to doc/mainpage.dox 

git-svn-id: svn+ssh://svn.gna.org/svn/warzone/trunk@4703 4a71c877-e1ca-e34f-864e-861f7616d084
master
Giel van Schijndel 2008-04-20 20:17:38 +00:00
parent cf04b1797d
commit 1d129c1b13
3 changed files with 26 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Doxyfile
View File

@ -473,7 +473,8 @@ WARN_LOGFILE =
# with spaces.
INPUT = ./src \
./lib
./lib \
./doc/mainpage.dox
# This tag can be used to specify the character encoding of the source files that
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default

22
doc/mainpage.dox Normal file
View File

@ -0,0 +1,22 @@
/** @mainpage Warzone2100 Code Documentation
*
* @section intro_sec Introduction
*
* Welcome to the Warzone2100 Resurrection Project's code library! We are still only starting
* to document this code base, but it should already be useful for quickly browsing around the
* code and getting an idea of what exists and how things work.
*
* @section install_sec Where to begin
*
* @subsection step1 Step 1: Read the wiki documentation
*
* We have a great deal of documentation on our wiki page at http://wiki.wz2100.net/ which
* may help get you started. Please also take notice of our style guide!
*
* @subsection step2 Step 2: Skim main.c
*
* You may want to begin reading code with main.c, since this is where execution begins,
* and trace code paths from here.
*
* Have fun!
*/

27
src/main.c
View File

@ -17,35 +17,10 @@
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file main.c
*
/** @file
* The main file that launches the game and starts up everything.
*/
/** @mainpage Warzone2100 Code Documentation
*
* @section intro_sec Introduction
*
* Welcome to the Warzone2100 Resurrection Project's code library! We are still only starting
* to document this code base, but it should already be useful for quickly browsing around the
* code and getting an idea of what exists and how things work.
*
* @section install_sec Where to begin
*
* @subsection step1 Step 1: Read the wiki documentation
*
* We have a great deal of documentation on our wiki page at http://wiki.wz2100.net/ which
* may help get you started. Please also take notice of our style guide!
*
* @subsection step2 Step 2: Skim main.c
*
* You may want to begin reading code with main.c, since this is where execution begins,
* and trace code paths from here.
*
* Have fun!
*/
// Get platform defines before checking for them!
#include "lib/framework/frame.h"