Skip to content

Commit

Permalink
docs: added doxygen support and doxygen build scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
owenson authored and Andrew Tridgell committed Aug 13, 2013
1 parent 8378dc9 commit 48753c6
Show file tree
Hide file tree
Showing 10 changed files with 1,945 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/README
Original file line number Diff line number Diff line change
@@ -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 changes: 13 additions & 0 deletions docs/build-apmrover2.sh
Original file line number Diff line number Diff line change
@@ -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 changes: 13 additions & 0 deletions docs/build-arducopter.sh
Original file line number Diff line number Diff line change
@@ -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 changes: 13 additions & 0 deletions docs/build-arduplane.sh
Original file line number Diff line number Diff line change
@@ -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 changes: 5 additions & 0 deletions docs/build-libs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/bash
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

cd $DIR/..
doxygen docs/config/libraries
7 changes: 7 additions & 0 deletions docs/config/apmrover2
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@INCLUDE = docs/config/default

INPUT = APMrover2/
OUTPUT_DIRECTORY = docs/APMrover2
HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries

7 changes: 7 additions & 0 deletions docs/config/arducopter
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@INCLUDE = docs/config/default

INPUT = ArduCopter/
OUTPUT_DIRECTORY = docs/ArduCopter
HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries

7 changes: 7 additions & 0 deletions docs/config/arduplane
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@INCLUDE = docs/config/default

INPUT = ArduPlane/
OUTPUT_DIRECTORY = docs/ArduPlane
HTML_OUTPUT = .
TAGFILES = docs/tags/libraries=../libraries

Loading

0 comments on commit 48753c6

Please sign in to comment.