Skip to content

added documentation build to workflows, turned on doxygen warnings for missing documentation #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edwardhartnett merged 9 commits into from
Feb 18, 2021
Merged

added documentation build to workflows, turned on doxygen warnings for missing documentation #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5b160bf
added new workflow for documentaiton build
edwardhartnett Feb 17, 2021
c23d3d4
changing new workflow for documentaiton build
edwardhartnett Feb 17, 2021
8264ebe
changing new workflow for documentaiton build
edwardhartnett Feb 17, 2021
cff10d4
turn on doxygen warnings
edwardhartnett Feb 17, 2021
7fcc8a9
fail on doxygen warnings
edwardhartnett Feb 17, 2021
1be6f10
trying warn_as_error
edwardhartnett Feb 17, 2021
702b538
setting warn_as_error back to NO
edwardhartnett Feb 17, 2021
ed0fe17
turning on docs build in existing workflows
edwardhartnett Feb 17, 2021
5ae49bf
removed unneeded workflow
edwardhartnett Feb 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/esmf-8.0.1_jasper-2.0.22_nceplibs-1.3.0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
export ESMFMKFILE=~/esmf/lib/esmf.mk
cd ufs_utils
mkdir build && cd build
cmake .. -DCMAKE_PREFIX_PATH='~;~/jasper;~/nceplibs'
cmake .. -DCMAKE_PREFIX_PATH='~;~/jasper;~/nceplibs' -DENABLE_DOCS=On
make -j2
make test

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/esmf-8.0.1_jasper-2.0.22_nceplibs-develop.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ jobs:
export ESMFMKFILE=~/esmf/lib/esmf.mk
cd ufs_utils
mkdir build && cd build
cmake .. -DCMAKE_PREFIX_PATH='~;~/jasper'
cmake .. -DCMAKE_PREFIX_PATH='~;~/jasper' -DENABLE_DOCS=On
make -j2
make test

Expand Down
6 changes: 5 additions & 1 deletion docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -697,7 +697,7 @@ WARNINGS = YES
# will automatically be disabled.
# The default value is: YES.

WARN_IF_UNDOCUMENTED = NO
WARN_IF_UNDOCUMENTED = YES

# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
Expand Down Expand Up @@ -731,6 +731,10 @@ WARN_FORMAT = "$file:$line: $text"

WARN_LOGFILE =

# WARN_AS_ERROR causes warnings to be treated as errors.

WARN_AS_ERROR = NO

#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
Expand Down