-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* basic doxygen configuration * fix up documentation and add main page * change default value of PROJECT_NUMBER * generalize * avoid displaying RMW_* function macros * remove unnecessary section
- Loading branch information
Showing
7 changed files
with
159 additions
and
63 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 @@ | ||
doc_output |
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,25 @@ | ||
# All settings not listed here will use the Doxygen default values. | ||
|
||
PROJECT_NAME = "rmw" | ||
PROJECT_NUMBER = master | ||
PROJECT_BRIEF = "C API providing a middleware abstraction layer which is used to implement the rest of ROS." | ||
|
||
INPUT = ./include | ||
RECURSIVE = YES | ||
OUTPUT_DIRECTORY = doc_output | ||
|
||
EXTRACT_ALL = YES | ||
SORT_MEMBER_DOCS = NO | ||
|
||
GENERATE_LATEX = NO | ||
|
||
ENABLE_PREPROCESSING = YES | ||
MACRO_EXPANSION = YES | ||
EXPAND_ONLY_PREDEF = YES | ||
PREDEFINED += RMW_PUBLIC= | ||
PREDEFINED += RMW_WARN_UNUSED= | ||
|
||
# Tag files that do not exist will produce a warning and cross-project linking will not work. | ||
TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" | ||
# Uncomment to generate tag files for cross-project linking. | ||
#GENERATE_TAGFILE = "../../../../doxygen_tag_files/rmw.tag" |
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
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
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
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
Oops, something went wrong.