Browse Source

Added a README to doc on how to generate documentation with doxygen. In main README, added a mention to check the REAME in doc.

QGC4.4
Jessica 13 years ago
parent
commit
0b7f080e22
  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
========
@ -99,4 +103,3 @@ Windows XP/7: @@ -99,4 +103,3 @@ Windows XP/7:
6) Compile and edit in Visual Studio. If you need to add new files, add them to qgroundcontrol.pro and re-run `qmake -tp vc qgroundcontrol.pro`

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.
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