Branch: refs/heads/master Author: Colomban Wendling ban@herbesfolles.org Committer: Colomban Wendling ban@herbesfolles.org Date: Wed, 12 Feb 2025 09:44:25 UTC Commit: 0e8f06e8afa594a2b5247cd07267fdfe1eae8e30 https://github.com/geany/geany/commit/0e8f06e8afa594a2b5247cd07267fdfe1eae8e...
Log Message: ----------- Silence spurious undocumented warnings when generating GI
Weirdly enough, if the HTML (or possibly LATEX?) output is not generated, Doxygen incorrectly warns about all parameters and return values not being documented.
Workaround this by disabling undocumented warnings when generating GI which only produces XML, and thus triggers the bug.
See https://stackoverflow.com/a/38745256
Modified Paths: -------------- doc/Doxyfile.in doc/Makefile.am doc/meson.build
Modified: doc/Doxyfile.in 4 lines changed, 2 insertions(+), 2 deletions(-) =================================================================== @@ -739,7 +739,7 @@ WARNINGS = YES # will automatically be disabled. # The default value is: YES.
-WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = @WARN@
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters @@ -755,7 +755,7 @@ WARN_IF_DOC_ERROR = YES # documentation, but not about the absence of documentation. # The default value is: NO.
-WARN_NO_PARAMDOC = YES +WARN_NO_PARAMDOC = @WARN@
# 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
Modified: doc/Makefile.am 2 lines changed, 2 insertions(+), 0 deletions(-) =================================================================== @@ -101,6 +101,7 @@ Doxyfile: Doxyfile.in -e 's,$(AT)HTML$(AT),YES,' \ -e 's,$(AT)XML$(AT),NO,' \ -e 's,$(AT)SORT$(AT),YES,' \ + -e 's,$(AT)WARN$(AT),YES,' \ $< > $@ || ( $(RM) -f $@ ; exit 1 )
doxygen_sources = \ @@ -141,6 +142,7 @@ Doxyfile-gi: Doxyfile.in -e 's,$(AT)HTML$(AT),NO,' \ -e 's,$(AT)XML$(AT),YES,' \ -e 's,$(AT)SORT$(AT),NO,' \ + -e 's,$(AT)WARN$(AT),NO,' \ $< > $@ || ( $(RM) -f $@ ; exit 1 )
# we depend on Doxyfile.stamp not have this run in parallel with it to avoid
Modified: doc/meson.build 2 lines changed, 2 insertions(+), 0 deletions(-) =================================================================== @@ -88,12 +88,14 @@ if doxygen.found() doxcfg.set('HTML', 'YES') doxcfg.set('XML', 'NO') doxcfg.set('SORT', 'YES') + doxcfg.set('WARN', 'YES')
doxgicfg = doxcfg doxgicfg.set('GIRONLY', '') doxgicfg.set('HTML', 'NO') doxgicfg.set('XML', 'YES') doxgicfg.set('SORT', 'NO') + doxgicfg.set('WARN', 'NO')
dep_doxygen = files([ 'plugins.dox',
-------------- This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).