From 1f2948cc5e0ba11d614ef32bf7bce6a65a523bd7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Hern=C3=A1ndez=20Cordero?= Date: Mon, 29 Jun 2020 08:08:04 +0200 Subject: [PATCH] Added Doxyfile (#85) * Added Doxyfile Signed-off-by: ahcorde * GitHub workflow that runs doxygen Signed-off-by: Steve Peters * Rename action Signed-off-by: Steve Peters * action: install graphviz Signed-off-by: Steve Peters Co-authored-by: Steve Peters --- .github/workflows/doxygen.yml | 17 +++++++++++++++++ Doxyfile | 24 ++++++++++++++++++++++++ QUALITY_DECLARATION.md | 2 +- 3 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/doxygen.yml create mode 100644 Doxyfile diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml new file mode 100644 index 0000000..808c99f --- /dev/null +++ b/.github/workflows/doxygen.yml @@ -0,0 +1,17 @@ +name: Doxygen + +on: [push, pull_request] + +jobs: + build: + + runs-on: ubuntu-18.04 + + steps: + - uses: actions/checkout@v2 + - name: Install base dependencies + run: | + sudo apt update; + sudo apt -y install doxygen graphviz + - name: doxygen Doxyfile + run: doxygen Doxyfile diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..0c1853c --- /dev/null +++ b/Doxyfile @@ -0,0 +1,24 @@ +# All settings not listed here will use the Doxygen default values. + +PROJECT_NAME = "console_bridge_dev" +PROJECT_NUMBER = master +PROJECT_BRIEF = "It is a ROS-independent, pure CMake (i.e. non-catkin and non-rosbuild package)\ + that provides logging calls that mirror those found in rosconsole, but for applications that are \ + not necessarily using ROS." + +INPUT = README.md ./include ./QUALITY_DECLARATION.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 + +# Tag files that do not exist will produce a warning and cross-project linking will not work. +GENERATE_TAGFILE = "../../../doxygen_tag_files/console_bridge_dev.tag" diff --git a/QUALITY_DECLARATION.md b/QUALITY_DECLARATION.md index 5609298..9910d08 100644 --- a/QUALITY_DECLARATION.md +++ b/QUALITY_DECLARATION.md @@ -1,6 +1,6 @@ This document is a declaration of software quality for the `libconsole-bridge-dev` ROS external dependency, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). -# `libconsole-bridge-dev` Quality Declaration +# libconsole-bridge-dev Quality Declaration The ROS external dependency `libconsole-bridge-dev` claims to be in the **Quality Level 2** category.