mainnika/weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc/sphinx: Make doxygen warn as error depend on meson werror flag

Browse Source 
As seen previous times, with newer doxygen version we seem to be
generating warnings and with it to stop generating documentation
entirely as we have enabled warning as error in the doxygen
configuration file.

By default meson werror build option is not enabled, so users can still
generate documentation when building regularly, and when we'll update to
the same doxygen version we should be able to catch those errors up if
any of them will pile up in between.

Suggested-by: Pekka Paalanen <pekka.paalanen@collabora.com>
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
(cherry picked from commit 402d9a81c9a42b0dcfc457c80382c36f5cecc6e6)
This commit is contained in:
Marius Vlad
2022-09-16 15:58:18 +03:00
parent 24ee61445c
commit 0da83cc1d8
2 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/sphinx/doxygen.ini.in
+1 -1
View File
@@ -759,7 +759,7 @@ WARN_NO_PARAMDOC = NO
# a warning is encountered. # a warning is encountered.
# The default value is: NO. # The default value is: NO.
WARN_AS_ERROR = YES WARN_AS_ERROR = @MESON_WERROR@
# The WARN_FORMAT tag determines the format of the warning messages that doxygen # The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which # can produce. The string should contain the $file, $line, and $text tags, which
doc/sphinx/meson.build
+1
View File
@@ -39,6 +39,7 @@ sphinx_conf = configure_file(
doxy_conf_data = configuration_data() doxy_conf_data = configuration_data()
doxy_conf_data.set('SRC_ROOT', meson.source_root()) doxy_conf_data.set('SRC_ROOT', meson.source_root())
doxy_conf_data.set('OUTPUT_DIR', doxygen_database) doxy_conf_data.set('OUTPUT_DIR', doxygen_database)
doxy_conf_data.set('MESON_WERROR', get_option('werror') == true ? 'YES' : 'NO')
doxygen_conf_weston = configure_file( doxygen_conf_weston = configure_file(
input: 'doxygen.ini.in', input: 'doxygen.ini.in',
output: 'doxygen.ini', output: 'doxygen.ini',