Skip to content

Commit

Permalink
Added Doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gabryelreyes committed Nov 13, 2023
1 parent 85076f6 commit 08ef8f7
Show file tree
Hide file tree
Showing 4 changed files with 2,792 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,26 @@ jobs:
- name: Run tests on native environment
run: platformio test --environment native -vvv

# Build documentation
doc:
# The type of runner that the job will run on.
runs-on: ubuntu-latest
needs: intro

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set up graphviz
uses: ts-graphviz/setup-graphviz@v1.2.0

- name: Set up doxygen and generate documentation for SerialMuxProt
uses: mattnotmitt/doxygen-action@v1.9.5
with:
working-directory: './doc/doxygen'
doxyfile-path: './Doxyfile'

- name: Print doxygen warnings
if: ${{ failure() }}
run: cat ./doc/doxygen/doxygen_warnings.txt
1 change: 1 addition & 0 deletions doc/doxygen/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*/html/*
Loading

0 comments on commit 08ef8f7

Please sign in to comment.