Skip to content

Commit

Permalink
Modify doxygen check to use common CI actions repository (FreeRTOS#257)
Browse files Browse the repository at this point in the history
* Update the ci to use common actions

* Remove unused options
  • Loading branch information
AniruddhaKanhere authored May 21, 2021
1 parent a6748f1 commit 7fe92a2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 43 deletions.
12 changes: 4 additions & 8 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,10 @@ jobs:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: Install Doxygen
run: |
wget -qO- "http://doxygen.nl/files/doxygen-1.9.1.linux.bin.tar.gz" | sudo tar --strip-components=1 -xz -C /usr/local
sudo apt-get install -y libclang-9-dev
- name: Run Doxygen And Verify Stdout Is Empty
run: |
doxygen docs/doxygen/config.doxyfile 2>&1 | tee doxyoutput.txt
if [[ "$(wc -c < doxyoutput.txt | bc)" = "0" ]]; then exit 0; else exit 1; fi
- name: Run doxygen build
uses: FreeRTOS/CI-CD-Github-Actions/doxygen@main
with:
path: ./

build-checks:
runs-on: ubuntu-latest
Expand Down
35 changes: 0 additions & 35 deletions docs/doxygen/config.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -536,13 +536,6 @@ EXTRACT_LOCAL_METHODS = NO

EXTRACT_ANON_NSPACES = NO

# If this flag is set to YES, the name of an unnamed parameter in a declaration
# will be determined by the corresponding definition. By default unnamed
# parameters remain unnamed in the output.
# The default value is: YES.

RESOLVE_UNNAMED_PARAMS = YES

# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
Expand Down Expand Up @@ -1130,12 +1123,6 @@ VERBATIM_HEADERS = YES

CLANG_ASSISTED_PARSING = NO

# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
# YES then doxygen will add the directory of each input to the include path.
# The default value is: YES.

CLANG_ADD_INC_PATHS = YES

# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
Expand Down Expand Up @@ -2413,28 +2400,6 @@ UML_LOOK = NO

UML_LIMIT_NUM_FIELDS = 10

# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
# tag is set to YES, doxygen will add type and arguments for attributes and
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
# will not generate fields with class member information in the UML graphs. The
# class diagrams will look similar to the default class diagrams but using UML
# notation for the relationships.
# Possible values are: NO, YES and NONE.
# The default value is: NO.
# This tag requires that the tag UML_LOOK is set to YES.

DOT_UML_DETAILS = NO

# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
# to display on a single line. If the actual line length exceeds this threshold
# significantly it will wrapped across multiple lines. Some heuristics are apply
# to avoid ugly line breaks.
# Minimum value: 0, maximum value: 1000, default value: 17.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_WRAP_THRESHOLD = 17

# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
Expand Down

0 comments on commit 7fe92a2

Please sign in to comment.