quakeforge/doc/quakeforge.dox

//unfortunately, have to wrap the docs in a C comment for doxygen
// vim:tw=74:formatoptions-=l
/**
\mainpage QuakeForge

QuakeForge is a 3D graphics game engine based on
<a href="http://www.idsoftware.com/">id Software's</a> legendary
Quake and QuakeWorld game engine.  Our purpose?  To improve the state of the
game by improving the engine and making it accessible to the largest number
of players we can.

\li \subpage build-install
\li \subpage faq
\li \subpage run_config
\li \subpage specs
*/
Run the docs through aspell. 2011-08-20 10:55:54 +00:00			`//unfortunately, have to wrap the docs in a C comment for doxygen`
Put my text editing vim settings into the docs. Vim's autoformating doesn't like our style of comments, so I have to force it to do what I want. Having to set the appropriate options every time I edit a file got to be a RPITA, so time to get the computer to do it for me :) 2011-09-08 01:17:58 +00:00			`// vim:tw=74:formatoptions-=l`
some documentation work 2005-07-27 12:14:35 +00:00			`/**`
			`\mainpage QuakeForge`
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00
			`QuakeForge is a 3D graphics game engine based on`
			`<a href="http://www.idsoftware.com/">id Software's</a> legendary`
some documentation work 2005-07-27 12:14:35 +00:00			`Quake and QuakeWorld game engine. Our purpose? To improve the state of the`
Run the docs through aspell. 2011-08-20 10:55:54 +00:00			`game by improving the engine and making it accessible to the largest number`
some documentation work 2005-07-27 12:14:35 +00:00			`of players we can.`

Convert and link INSTALL into our doxygen docs. 2011-08-16 05:17:17 +00:00			`\li \subpage build-install`
Start giving some structure to the non-code docs. Use subpage instead of ref. This actually moves the so-referenced pages out of "Related Pages". I imagine they'll form a tree in the menu, but I don't have that config here. 2010-08-20 03:33:07 +00:00			`\li \subpage faq`
Do some work on the user documentation. Also document part of the cvar api. 2011-09-07 12:08:37 +00:00			`\li \subpage run_config`
Begin documenting sound and tidy up specifications. 2011-09-08 05:38:57 +00:00			`\li \subpage specs`
some documentation work 2005-07-27 12:14:35 +00:00			`*/`