doc: make doxygen comply with meson werror option

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>

diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 42d3891..ddef755 100644 (file)
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -108,3 +108,5 @@ GENERATE_LATEX          = NO
 GENERATE_MAN            = NO
 
 HAVE_DOT                = NO
+
+WARN_AS_ERROR           = @WARN_AS_ERROR@

diff --git a/doc/api/meson.build b/doc/api/meson.build
index e9b49f9..4f51f5d 100644 (file)
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -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',