Browse Source

Merge pull request #129 from jjhall89/doxygenTarget

Doxygen
QGC4.4
Lorenz Meier 13 years ago
parent
commit
b3a7483241
  1. 5
      README
  2. 37
      doc/README

5
README

@ -14,6 +14,10 @@ http://qgroundcontrol.org/credits @@ -14,6 +14,10 @@ http://qgroundcontrol.org/credits
* PLEASE NOTE: YOU NEED TO DOWNLOAD THE MAVLINK LIBRARY IN ORDER TO COMPILE THIS APPLICATION *
**********************************************************************************************
Documentation
=============
For gernerating documentation, refer to README in the doc directory.
Mac OS X
========
@ -174,4 +178,3 @@ thirdParty: @@ -174,4 +178,3 @@ thirdParty:
Library called lxbee.
Library called QSerialPort.

37
doc/README

@ -0,0 +1,37 @@ @@ -0,0 +1,37 @@
Linux/Mac OS X
==============
To install doxygen:
$sudo apt-get install doxygen
If the above does not work go to:
http://www.stack.nl/~dimitri/doxygen/download.html for the correct download.
Then go to the following website for inforamtion on the install:
http://www.stack.nl/~dimitri/doxygen/install.html
Then to generate the html, run the following code while you are in the qgroundcontrol/doc directory:
$doxygen Doxyfile
The html file index.html should be in doc/html unless you chenged the output directory.
The other option for generating the documentation is to use the wizard:
$doxywizard &
doxywizard information:
http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html
Or go to the Doxygen Manual for information at the website noted below.
Windows
=======
Go to the following website for the correct download and follow the wizard to install:
http://www.stack.nl/~dimitri/doxygen/download.html
Run the wizard to generate the documentation.
Go to the website below or the Doxygen Manual for information on running doxywizard.
http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html
Doxygen Manual
==============
http://www.stack.nl/~dimitri/doxygen/
Loading…
Cancel
Save