diff options
| author | Marius Vlad <marius.vlad@collabora.com> | 2022-09-16 15:58:18 +0300 |
|---|---|---|
| committer | Pekka Paalanen <pq@iki.fi> | 2022-09-23 11:37:06 +0000 |
| commit | 402d9a81c9a42b0dcfc457c80382c36f5cecc6e6 (patch) | |
| tree | e14b204e8ca12c2e33770d81c4dcd2ac39b5ddfa /doc | |
| parent | 8c4cdd782e17aa587bfccb6746998571ddc90dd7 (diff) | |
| download | weston-402d9a81c9a42b0dcfc457c80382c36f5cecc6e6.tar.gz | |
doc/sphinx: Make doxygen warn as error depend on meson werror flag
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/sphinx/doxygen.ini.in | 2 | ||||
| -rw-r--r-- | doc/sphinx/meson.build | 1 |
2 files changed, 2 insertions, 1 deletions
diff --git a/doc/sphinx/doxygen.ini.in b/doc/sphinx/doxygen.ini.in index 1e71d07b..29f57882 100644 --- a/doc/sphinx/doxygen.ini.in +++ b/doc/sphinx/doxygen.ini.in @@ -759,7 +759,7 @@ WARN_NO_PARAMDOC = NO # a warning is encountered. # 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 # can produce. The string should contain the $file, $line, and $text tags, which diff --git a/doc/sphinx/meson.build b/doc/sphinx/meson.build index 46947a6b..1f573624 100644 --- a/doc/sphinx/meson.build +++ b/doc/sphinx/meson.build @@ -39,6 +39,7 @@ sphinx_conf = configure_file( doxy_conf_data = configuration_data() doxy_conf_data.set('SRC_ROOT', meson.source_root()) 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( input: 'doxygen.ini.in', output: 'doxygen.ini', |