-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
Showing
3 changed files
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters