From f4ed5d1b9a0eb1b679731255fa27385503031c72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Hern=C3=A1ndez=20Cordero?= Date: Fri, 19 Jun 2020 08:44:19 +0200 Subject: [PATCH] Added Doxyfile and fixed related warnings (#42) Signed-off-by: ahcorde --- rcl_logging_spdlog/Doxyfile | 28 +++++++++++++++++++++++ rcl_logging_spdlog/QUALITY_DECLARATION.md | 2 +- rcl_logging_spdlog/README.md | 2 +- 3 files changed, 30 insertions(+), 2 deletions(-) create mode 100644 rcl_logging_spdlog/Doxyfile diff --git a/rcl_logging_spdlog/Doxyfile b/rcl_logging_spdlog/Doxyfile new file mode 100644 index 0000000..a124fe1 --- /dev/null +++ b/rcl_logging_spdlog/Doxyfile @@ -0,0 +1,28 @@ +# All settings not listed here will use the Doxygen default values. + +PROJECT_NAME = "rcl_logging_spdlog" +PROJECT_NUMBER = master +PROJECT_BRIEF = "Implementation of rcl_logging API for an spdlog backend." + +# Use these lines to include the generated logging_macro.h (update install path if needed) +INPUT = README.md ../../../../install/rcl_logging_interface/include ./QUALITY_DECLARATION.md + +# Otherwise just generate for the local (non-generated header files) +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 + +# 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/" +TAGFILES += "../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org/latest/api/rcutils/" +# Uncomment to generate tag files for cross-project linking. +GENERATE_TAGFILE = "../../../doxygen_tag_files/rcl_logging_spdlog.tag" diff --git a/rcl_logging_spdlog/QUALITY_DECLARATION.md b/rcl_logging_spdlog/QUALITY_DECLARATION.md index 23e9b4d..d9899ee 100644 --- a/rcl_logging_spdlog/QUALITY_DECLARATION.md +++ b/rcl_logging_spdlog/QUALITY_DECLARATION.md @@ -1,6 +1,6 @@ This document is a declaration of software quality for the `rcl_logging_spdlog` package, based on the guidelines in [REP-2004](https://github.com/ros-infrastructure/rep/blob/rep-2004/rep-2004.rst). -# `rcl_logging_spdlog` Quality Declaration +# rcl_logging_spdlog Quality Declaration The package `rcl_logging_spdlog` claims to be in the **Quality Level 4** category. diff --git a/rcl_logging_spdlog/README.md b/rcl_logging_spdlog/README.md index 8b42cb9..eac9b68 100644 --- a/rcl_logging_spdlog/README.md +++ b/rcl_logging_spdlog/README.md @@ -14,4 +14,4 @@ Some useful internal abstractions and utilities: ## Quality Declaration -This package claims to be in the **Quality Level 4** category, see the [Quality Declaration](./Quality_Declaration.md) for more details. +This package claims to be in the **Quality Level 4** category, see the [Quality Declaration](./QUALITY_DECLARATION.md) for more details.