forked from ArduPilot/ardupilot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added doxygen support and doxygen build scripts
- Loading branch information
Showing
10 changed files
with
1,945 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
Oops, something went wrong.