Rualib: documentation updates.

Add a layout file for Rua docs and create groups for its library functions.
This commit is contained in:
Jeff Teunissen 2011-06-14 13:08:48 -04:00
parent 42ab0a7dbb
commit cb86e09029
8 changed files with 233 additions and 21 deletions

184
doc/ruadoc-layout.xml Normal file
View file

@ -0,0 +1,184 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="yes" title=""/>
<tab type="modules" visible="yes" title=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespaces" visible="no" title=""/>
<tab type="namespacemembers" visible="yes" title=""/>
</tab>
<tab type="classes" visible="yes" title="Classes &amp; Structures">
<tab type="classes" visible="no" title=""/>
<tab type="hierarchy" visible="yes" title=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="classmembers" visible="yes" title="Class Ivars &amp; Methods"/>
</tab>
<tab type="files" visible="yes" title="">
<tab type="files" visible="no" title=""/>
<tab type="globals" visible="yes" title=""/>
</tab>
<tab type="dirs" visible="yes" title=""/>
<tab type="examples" visible="yes" title=""/>
</navindex>
<!-- Layout definition for a class page -->
<class>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<briefdescription visible="no"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<detaileddescription title="Class Description"/>
<authorsection visible="yes"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title="Instance Methods"/>
<publicstaticmethods title="Class Methods"/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<protectedtypes title=""/>
<protectedslots title=""/>
<protectedmethods title=""/>
<protectedstaticmethods title=""/>
<protectedattributes title=""/>
<protectedstaticattributes title=""/>
<packagetypes title=""/>
<packagemethods title=""/>
<packagestaticmethods title=""/>
<packageattributes title=""/>
<packagestaticattributes title=""/>
<properties title=""/>
<events title=""/>
<privatetypes title=""/>
<privateslots title=""/>
<privatemethods title=""/>
<privatestaticmethods title=""/>
<privateattributes title=""/>
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
<allmemberslink visible="yes"/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<constructors title=""/>
<functions title="Method Documentation"/>
<related title=""/>
<variables title=""/>
<properties title=""/>
<events title=""/>
</memberdef>
<usedfiles visible="$SHOW_USED_FILES"/>
</class>
<!-- Layout definition for a namespace page -->
<namespace>
<briefdescription visible="yes"/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection visible="yes"/>
</namespace>
<!-- Layout definition for a file page -->
<file>
<briefdescription visible="no"/>
<includegraph visible="$INCLUDE_GRAPH"/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<detaileddescription title=""/>
<sourcelink visible="yes"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<memberdef>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection/>
</file>
<!-- Layout definition for a group page -->
<group>
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<dirs visible="yes" title=""/>
<nestedgroups visible="yes" title=""/>
<files visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
</memberdef>
<authorsection visible="yes"/>
</group>
<!-- Layout definition for a directory page -->
<directory>
<briefdescription visible="yes"/>
<directorygraph visible="yes"/>
<memberdecl>
<dirs visible="yes"/>
<files visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
</directory>
</doxygenlayout>

View file

@ -520,7 +520,7 @@ FILE_VERSION_FILTER =
# You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file.
LAYOUT_FILE =
LAYOUT_FILE = @TOPSRC@/doc/ruadoc-layout.xml
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
@ -584,9 +584,9 @@ WARN_LOGFILE =
INPUT = @TOPSRC@/ruamoko/include/
INPUT += @TOPSRC@/ruamoko/lib/
INPUT += @TOPSRC@/ruamoko/game/
#INPUT += @TOPSRC@/ruamoko/game/
INPUT += @TOPSRC@/ruamoko/gui/
INPUT += @TOPSRC@/ruamoko/cl_menu/
#INPUT += @TOPSRC@/ruamoko/cl_menu/
# 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
@ -1353,7 +1353,7 @@ DOT_NUM_THREADS = 0
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans.ttf
DOT_FONTNAME = Arial
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
@ -1402,14 +1402,14 @@ TEMPLATE_RELATIONS = NO
# file showing the direct and indirect include dependencies of the file with
# other documented files.
INCLUDE_GRAPH = NO
INCLUDE_GRAPH = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = YES
INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
@ -1430,7 +1430,7 @@ CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
GRAPHICAL_HIERARCHY = NO
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories

View file

@ -1,6 +1,10 @@
#ifndef __ruamoko_crudefile_h
#define __ruamoko_crudefile_h
/**
\defgroup crudefile Crudefile Functions
\{
*/
@extern float cfopen (string path, string mode);
@extern void cfclose (float desc);
@extern string cfread (float desc);
@ -8,4 +12,7 @@
@extern float cfeof (float desc);
@extern float cfquota (void);
/**
\}
*/
#endif//__ruamoko_crudefile_h

View file

@ -1,7 +1,6 @@
/**
\file debug.h
Debugging function definitions
\defgroup debug Debugging Functions
\{
*/
/*
@ -76,4 +75,5 @@
*/
@extern void objerror (string e);
//\}
#endif //__ruamoko_debug_h

View file

@ -1,10 +1,10 @@
/**
\file entities.h
\defgroup entities Entity Handling
\{
Built-in functions for dealing with Quake entities.
These builtin functions create, modify, delete, etc. Quake entities.
*/
/*
Copyright (C) 2002 Bill Currie <taniwha@quakeforge.net>
Copyright (C) 2002 Jeff Teunissen <deek@quakeforge.net>
@ -28,8 +28,6 @@
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
$Id$
*/
#ifndef __ruamoko_entities_h
#define __ruamoko_entities_h
@ -113,5 +111,7 @@
@extern entity nextent (entity e);
@extern void EntityParseFunction (void func (string ent_data));
///\}
//\}
//\}
#endif //__ruamoko_entities_h

View file

@ -31,6 +31,11 @@
#ifndef __ruamoko_math_h
#define __ruamoko_math_h
/**
\defgroup math Math Functions
\{
*/
/**
Generate a random number such that 0 <= n <= 1 (0 to 1 inclusive)
*/
@ -70,8 +75,6 @@
* VECTORS *
****************************************************************************/
@extern vector v_forward, v_up, v_right;
/**
Transform vector \a v into a unit vector (a vector with a length of 1).
The direction is not changed, except for (possible) roundoff errors.
@ -146,4 +149,6 @@
@extern float acosh (float x);
@extern float atanh (float x);
//\}
#endif //__ruamoko_math_h

View file

@ -1,3 +1,7 @@
/**
\defgroup physics Physics builtins
\{
*/
#ifndef __ruamoko_physics_h
#define __ruamoko_physics_h
@ -10,11 +14,12 @@
@extern entity trace_ent;
@extern float trace_inopen;
@extern float trace_inwater;
@extern vector v_forward;
@extern vector v_up;
@extern vector v_right;
/*
makevectors
Set v_forward, v_up, v_right global vectors from the vector ang
/**
Set #v_forward, #v_up, #v_right global vectors from the vector \a ang
*/
@extern void makevectors (vector ang);
@extern void traceline (vector v1, vector v2, float nomonsters, entity forent);
@ -33,4 +38,8 @@
@extern void freeboxhull (int hull);
@extern void rotate_bbox (int hull, vector right, vector forward, vector up, vector mins, vector maxs);
/**
\}
*/
#endif//__ruamoko_physics_h

View file

@ -1,3 +1,7 @@
/**
\defgroup runtime Objective Runtime
\{
*/
#ifndef __ruamoko_runtime_h_
#define __ruamoko_runtime_h_
@ -75,3 +79,6 @@ typedef enum {
@extern BOOL object_is_meta_class (id object);
#endif //__ruamoko_runtime_h_
/**
\}
*/