docs: added doxygen support and doxygen build scripts

This commit is contained in:
Gareth Owen 2013-08-12 13:48:14 +01:00 committed by Andrew Tridgell
parent 8378dc9779
commit 48753c6182
10 changed files with 1945 additions and 0 deletions

4
docs/README Normal file
View File

@ -0,0 +1,4 @@
You need doxygen and graphviz installed.
Run the build-libs script first, then the project you're interested in.
HTMl will be generated and placed into docs/projectname.

13
docs/build-apmrover2.sh Executable file
View File

@ -0,0 +1,13 @@
#!/bin/bash
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
if [ ! -f docs/tags/libraries ];
then
echo "Must build libraries first"
exit 0
fi
doxygen docs/config/apmrover2

13
docs/build-arducopter.sh Executable file
View File

@ -0,0 +1,13 @@
#!/bin/bash
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
if [ ! -f docs/tags/libraries ];
then
echo "Must build libraries first"
exit 0
fi
doxygen docs/config/arducopter

13
docs/build-arduplane.sh Executable file
View File

@ -0,0 +1,13 @@
#!/bin/bash
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
if [ ! -f docs/tags/libraries ];
then
echo "Must build libraries first"
exit 0
fi
doxygen docs/config/arduplane

5
docs/build-libs.sh Executable file
View File

@ -0,0 +1,5 @@
#!/bin/bash
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/..
doxygen docs/config/libraries

7
docs/config/apmrover2 Normal file
View File

@ -0,0 +1,7 @@
@INCLUDE = docs/config/default
INPUT = APMrover2/
OUTPUT_DIRECTORY = docs/APMrover2
HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries

7
docs/config/arducopter Normal file
View File

@ -0,0 +1,7 @@
@INCLUDE = docs/config/default
INPUT = ArduCopter/
OUTPUT_DIRECTORY = docs/ArduCopter
HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries

7
docs/config/arduplane Normal file
View File

@ -0,0 +1,7 @@
@INCLUDE = docs/config/default
INPUT = ArduPlane/
OUTPUT_DIRECTORY = docs/ArduPlane
HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries

1870
docs/config/default Normal file

File diff suppressed because it is too large Load Diff

6
docs/config/libraries Normal file
View File

@ -0,0 +1,6 @@
@INCLUDE = docs/config/default
INPUT = libraries/
OUTPUT_DIRECTORY = docs/libraries
HTML_OUTPUT = .
GENERATE_TAGFILE = docs/tags/libraries