d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: make doxygen comply with meson werror option

Browse Source 
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>
This commit is contained in:
Bruce Richardson 2020-09-29 17:55:02 +01:00 committed by Thomas Monjalon
parent e5feab93a9
commit 1f16199945
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/doxy-api.conf.in
View File

@ -108,3 +108,5 @@ GENERATE_LATEX = NO
GENERATE_MAN = NO
HAVE_DOT = NO
WARN_AS_ERROR = @WARN_AS_ERROR@

4
doc/api/meson.build
View File

@ -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',