/ Create Doxygen documentation

OpenSceneGraph

Create Doxygen documentation

Details
Category: User Guides
Published: 05 February 2013
Written by openscenegraph
Hits: 18477
The OpenSceneGraph ReferenceGuides are built using Doxygen, the version available on this website is for the latest public release. To build the docuementation for the CVS version, or to just build local docs you'll need Doxygen + GraphViz's dot applications.

Doxygen can be download from:

http://www.doxygen.org

GrpahViz's dot can be download from:

http://www.graphviz.org/

To build the Doxygen docs you'll need to set the environmental variable OSGHOME to the root of the OpenSceneGraph and then run doxygen with one of the Doxygen files supplied with the OpenSceneGraph distribution:

cd /home/myaccount/[=OpenSceneGraph
export OSGHOME=`pwd`
doxygen doc/Doxyfiles/core_Doxyfile

Then wait for Doxygen to build the documentation. Once built it will be placed in doc/OpenSceneGraphReferenceDocs from here you can browse the documentation.