User:Callahanp/Flightgear and Simgear Code/Doxygen

From FlightGear wiki
Jump to: navigation, search

Go install Doxygen.

Simgear has configuration files already. Flightgear does not.


cd ~/fg/next/simgear
atom Doxyfile DoxygenMain.cxx  # set the output directory for the docs as ~/fg/docsf
mkdir -p ~/fg/docs
doxygen

cd ~/fg/next/flightgear
# copy the flightgear Doxygen files over to Flightgear 
# and modify them so they refer to Flightgear
cp ~/fg/next/simgear/Doxy* ./
atom Doxyfile DoxygenMain.cxx  # set the output directory for the docs as ~/fg/docsf
mkdir -p ~/fg/docsf
doxygen

cd ~/fg
google-chrome next/doxyf/html/index.html next/doxy/html/index.html

explore the files, which are listed in alphabetic order regardless of what folder they're in.

This is not perfect, and there are some broken things in the documentation, but it's good enough for our purposes. You can view the docs and access the source code in your browser. Dont push your flightgear Doxyfiles to git unless you fix them first. As is they are throwaways due to the errors.