Doxygen

From Shadowrun: Awakened

Doxygen is an automatic documentation generation tool for various programming languages, including C++.

Contents 1 Using Doxygen on SRA 1.1 Global settings 1.2 Folder structure 1.3 Individual Settings 1.3.1 SRA 1.3.2 OGRE 1.3.3 PhysX 2 Links

Using Doxygen on SRA

Documentation will be run on SRA on a regular basis while documentation for the associated and included libraries for OGRE and PhysX will be redone only when they are rarely updated.

Global settings

• Project Name is either Shadowrun: Awakened, OGRE, or PhysX
• Do not show full path names (otherwise will show your own PC's path)
• Brief and Detailed descriptions are listed at the top of an item's documentation (DETAILS_AT_TOP = YES)
• Extract static and local classes and hide undocumented classes and members
• Scan recursively
• Sort members, brief documentation, group names, and sort classes by scope
• Do not generate a to-do list, test list, bug list, or deprecated list
• Show used files; do not show directories
• Include source browser with inline sources; code comments stripped; all references on; verbatim headers on
• Include alphabetical index in two columns
• Generate HTML with a treeview
• Use Graphviz diagram generator by setting HAVE_DOT to YES
• Do not hide undocumented relations in diagrams
• Graph classes, groups, included classes, included by classes
• Do not graph class hierarchy
• Use transparent pngs for graphs with a legend
• Turn the PHP search engine on

Folder structure

<root>

• docs
  • ogre
    • html
  • physx
    • html

Individual Settings

SRA

• Output folder is root folder (root can be wherever you wish)
• Html output folder is docs
• Input is SRA_Development folder (see TortoiseSVN
• Exclude test folders, include folder, and lib folder
• TAGFILES = docs/ogre/ogre.tag=ogre/html \ docs/physx/physx.tag=physx/html
• ALLEXTERNALS = NO
• EXTERNAL_GROUPS = NO

OGRE

• Output folder is docs/ogre (absolute or relative path to working directory)
• Html output folder name is html (no path)
• Input is SRA_Development/Include/Ogre folder
• GENERATE_TAGFILE = docs/ogre/ogre.tag (Can use absolute path)

PhysX

• Output folder is docs/physx (absolute or relative path to working directory)
• Html output folder name is html (no path)
• Input is SRA_Development/Include/PhysX folder
• GENERATE_TAGFILE = docs/physx/physx.tag (Can use absolute path)

Links

• SRA Doxygen Documentation
• SRA OGRE Library Documentation
• SRA PhysX Library Documentation
• Download Page