Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[foxy backport] Added Doxyfile and fixed related warnings (#42) #46

Merged
merged 1 commit into from
Jun 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions rcl_logging_spdlog/Doxyfile
Original file line number Diff line number Diff line change
@@ -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"
2 changes: 1 addition & 1 deletion rcl_logging_spdlog/QUALITY_DECLARATION.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion rcl_logging_spdlog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.