Add API documentation and Doxyfile for tracetools

Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>

Change title

Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
This commit is contained in:
Christophe Bedard 2020-05-17 08:21:36 -04:00
parent 111985d64b
commit 493437c1f8
4 changed files with 172 additions and 17 deletions

32
tracetools/Doxyfile Normal file
View file

@ -0,0 +1,32 @@
# All settings not listed here will use the Doxygen default values.
# To use, see: https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing-api
PROJECT_NAME = "tracetools"
PROJECT_NUMBER = $(PROJECT_NUMBER)
PROJECT_BRIEF = "Tracing tools and instrumentation for ROS 2"
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 = NO
PREDEFINED = \
"TRACETOOLS_PUBLIC="
EXCLUDE_SYMBOLS = \
"DECLARE_TRACEPOINT" \
"_demangle_symbol" \
"_get_symbol_funcptr"
# Tag files that do not exist will produce a warning and cross-project linking will not work.
TAGFILES += "../../../data/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"
# Uncomment to generate tag files for cross-project linking.
GENERATE_TAGFILE = "../../../data/tracetools.tag"