Generate OpenSceneGraph documents using Doxygen, Graphviz

OpenSceneGraph is an open-source C + + three-dimensional engine library, but because it is open source, related documents are scarce. Although the official website provides the source code can directly generate Doxygen documents, but seemingly not very good, anyway I did not generate correctly.

I have studied the use of Doxygen, Graphviz generated openscenegraph documents, and finally successfully generated related documents, the process of tidying up, I hope to be helpful to everyone.

Raw materials:

Doxygen-1.8.11-setup, graphviz-2.38,

These two software are open source, respectively:

Http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.12-setup.exe

Http://graphviz.org/pub/graphviz/stable/windows/graphviz-2.38.msi

Two software installation is relatively simple, do not repeat.

Steps:

1. Find the OpenSceneGraph source path under the \doc\doxyfiles, this directory contains a variety of generated documents related configuration, I use "all_doxyfile", this file is a lot of variables we need to manually modify.

Mainly include: ${openscenegraph_version}, ${openscenegraph_source_dir}, ${doxygen_dot_path}

The first is the OSG version number (such as 3.5.1, according to the actual situation can be filled)

A second OSG source path

The third is the installation path of Graphviz, the path can not contain Chinese, space and other special characters, or in the generation process, will error, the specific error message is as follows:

Error:problems opening map file Xxxx.map for inclusion in the docs!

There is a need to modify the place is "Dot_graph_max_nodes", the default is 50, in the document generation will prompt you some diagram generation error, I modified to 500, perfect generation, no error.

2. Open Doxygen software, file-open-\doc\doxyfiles\all_doxyfile;

3. Click Run directly to generate the document.

Generate OpenSceneGraph documents using Doxygen, Graphviz