88888fb672
* basic doxygen configuration * fix documentation: rendering, typos, etc * add main page with directory * add rmw tag files and fix file references * generate tag file * generalizing * avoid showing RCL_* function macros * remove colliding and unnecessary section
27 lines
1 KiB
Text
27 lines
1 KiB
Text
# All settings not listed here will use the Doxygen default values.
|
|
|
|
PROJECT_NAME = "rcl"
|
|
PROJECT_NUMBER = master
|
|
PROJECT_BRIEF = "C API providing common ROS client library functionality."
|
|
|
|
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 += RCL_PUBLIC=
|
|
PREDEFINED += RCL_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/"
|
|
# Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0)
|
|
TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org/latest/api/rmw/"
|
|
# Uncomment to generate tag files for cross-project linking.
|
|
#GENERATE_TAGFILE = "../../../../doxygen_tag_files/rcl.tag"
|