[v2,6/6] doc/api: make doc warnings errors when werror option set
Checks
Commit Message
When the --werror meson build option is set, we can set the WARN_AS_ERRORS
doxygen option in the doxygen config flag to get the same behaviour for API
doc building as for building the rest of DPDK. This can help catch
documentation errors sooner in the development process.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/api/doxy-api.conf.in | 1 +
doc/api/meson.build | 4 ++++
2 files changed, 5 insertions(+)
Comments
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -89,6 +89,7 @@ HIDE_SCOPE_NAMES = YES
GENERATE_DEPRECATEDLIST = YES
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
+WARN_AS_ERROR = @WARN_AS_ERROR@
This section is about the appearance of the output.
I think this new "warning" option would better fit at the end of the file.
@@ -89,6 +89,7 @@ HIDE_SCOPE_NAMES = YES
GENERATE_DEPRECATEDLIST = YES
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
+WARN_AS_ERROR = @WARN_AS_ERROR@
HTML_TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = YES
@@ -37,6 +37,10 @@ cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
cdata.set('HTML_OUTPUT', 'html')
cdata.set('TOPDIR', meson.source_root())
cdata.set('STRIP_FROM_PATH', meson.source_root())
+cdata.set('WARN_AS_ERROR', 'NO')
+if get_option('werror')
+ cdata.set('WARN_AS_ERROR', 'YES')
+endif
doxy_conf = configure_file(input: 'doxy-api.conf.in',
output: 'doxy-api.conf',