Commit ed3d9104 authored by Alexander Wiebel's avatar Alexander Wiebel

[CHANGE #408] ignoring problematic files in doxygen and setting WARN_AS_ERROR=YES

See https://www.stack.nl/%7Edimitri/doxygen/manual/config.html#aWARN_AS_ERROR for details on this option.

It will terminate CI pipeline if something is not correctly documented.
parent 575b79f7
...@@ -550,6 +550,7 @@ WARN_FORMAT = "$file:$line: $text" ...@@ -550,6 +550,7 @@ WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = WARN_LOGFILE =
WARN_AS_ERROR = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
...@@ -590,9 +591,11 @@ RECURSIVE = YES ...@@ -590,9 +591,11 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag. # subdirectory from a directory tree whose root is specified with the INPUT tag.
# "ext" is excluded because we do not want to document external code
# "WStructuredTextParser" and "WTensorBase" confuse doxygen (see https://bsvgit.informatik.uni-leipzig.de/openwalnut/openwalnut/issues/408#note_6673 )
EXCLUDE = src/modules/data/ext \ EXCLUDE = src/modules/data/ext \
src/modules/lic/fibernavigator \ src/core/common/WStructuredTextParser.cpp \
src/modules/lic/fantom src/core/common/math/WTensorBase.h
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded # directories that are symbolic links (a Unix filesystem feature) are excluded
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment