Skip to content

Commit

Permalink
added rcl yaml param parser doxyfile (#634) (#700)
Browse files Browse the repository at this point in the history
* Added rcl yaml param parser Doxyfile

Signed-off-by: ahcorde <ahcorde@gmail.com>

* Added feedback

Signed-off-by: ahcorde <ahcorde@gmail.com>

* Fixed predefined tag

Signed-off-by: ahcorde <ahcorde@gmail.com>
  • Loading branch information
ahcorde authored Jun 26, 2020
1 parent bdc485c commit 06b4240
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions rcl_yaml_param_parser/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rcl_yaml_param_parser"
PROJECT_NUMBER = master
PROJECT_BRIEF = "Parse a YAML parameter file and populate the C data structure."

INPUT = ./include README.md
USE_MDFILE_AS_MAINPAGE = README.md
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 += RCL_YAML_PARAM_PARSER_PUBLIC=

# 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/"
# Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0)
TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org//api/rcutils/"
# Uncomment to generate tag files for cross-project linking.
GENERATE_TAGFILE = "../../../../doxygen_tag_files/rcl_yaml_param_parser.tag"

0 comments on commit 06b4240

Please sign in to comment.