Skip to content

Commit

Permalink
Added Doxyfile (#85)
Browse files Browse the repository at this point in the history
* Added Doxyfile

Signed-off-by: ahcorde <ahcorde@gmail.com>

* GitHub workflow that runs doxygen

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

* Rename action

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

* action: install graphviz

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

Co-authored-by: Steve Peters <scpeters@openrobotics.org>
  • Loading branch information
ahcorde and scpeters committed Jun 29, 2020
1 parent 3249f1d commit 1f2948c
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 1 deletion.
17 changes: 17 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -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
24 changes: 24 additions & 0 deletions Doxyfile
Original file line number Diff line number Diff line change
@@ -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"
2 changes: 1 addition & 1 deletion 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 `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.

Expand Down

0 comments on commit 1f2948c

Please # to comment.