Skip to content
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.

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

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

Merged
merged 9 commits into from
Feb 18, 2021
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
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
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