This removes the followings warnings when generating the docs: ``` warning: Tag 'LATEX_SOURCE_CODE' at line 1758 of file 'Doxyfile.tmp' has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" warning: Tag 'CLASS_DIAGRAMS' at line 2113 of file 'Doxyfile.tmp' has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" warning: Changing CLASS_GRAPH option to TEXT because obsolete option CLASS_DIAGRAM was found and set to NO. ``` You can view, comment on, or merge this pull request online at:
https://github.com/geany/geany/pull/3719
-- Commit Summary --
* Remove deprecated Doxygen settings
-- File Changes --
M doc/Doxyfile.in (19)
-- Patch Links --
https://github.com/geany/geany/pull/3719.patch https://github.com/geany/geany/pull/3719.diff
It might not matter, but `doxygen -u` sets `CLASS_GRAPH = TEXT` as it says in the warning, in addition to removing `CLASS_DIAGRAMS`. Should we do so, or even set it to `NO`, or maybe we don't actually care because we don't have actual classes anyway?
`doxygen -u` seems to update a lot more of the config, mostly updating comments.
I did not check in detail. We could update the config using the command at all, so far I only edited it manually to get the warnings resolved.
The warning only said it is changed because `CLASS_DIAGRAM` were set before, right? `doxygen -u` doesn't set it to "TEXT" here but to "YES", not sure why.
I don't mind how we proceed, I'm no doxygen expert at all.
The warning only said it is changed because `CLASS_DIAGRAM` were set before, right?
I guess so, yeah.
`doxygen -u` doesn't set it to "TEXT" here but to "YES", not sure why.
Does it? Here it does set it to `TEXT` as it warns about, Doxygen 1.9.4.
I don't mind how we proceed, I'm no doxygen expert at all.
Me neither, I was just wondering if it wouldn't start adding broken graphs everywhere, but I didn't test :)
`doxygen -u` seems to update a lot more of the config, mostly updating comments.
I did not check in detail. We could update the config using the command at all, so far I only edited it manually to get the warnings resolved.
I'm not suggesting we do that, at least not to actually change things. Maybe we could as a sanity pass, but I'm not sure what impacts it has on Doxygen dependency either.
Is the complaint new to a new versio0n of doxygen? And if we change it will it break old versions?
`doxygen -u` doesn't set it to "TEXT" here but to "YES", not sure why.
Does it? Here it does set it to `TEXT` as it warns about, Doxygen 1.9.4.
1.9.4 here as well. With current master it does change it to `TEXT`, with the changes of this PR it will stay at `YES`.
Is the complaint new to a new version of doxygen? And if we change it will it break old versions?
I can't answer those questions without having a deep dive into doxygen for what I have not enough time and motivation, TBH. You know, we generate some API docs which 99% of the users will never read or even notice.
Having said this, I would keep the config mainly as is and just remove the two obsolete values.
FWIW, this PR builds OK with 1.8.13 and generates *no* changes I could find (*doc/reference/* is the same, minus the build dates).
@b4n approved this pull request.
Makes recent Doxygen happy, and generates the same documentation than without the change with both 1.8.13 (Debian 10) and 1.9.4 (Debian 12).
Did you diff the XML and the GRRR, sorry GIR? :smile:
@elextr should be easy enough, go ahead ;) I can check tomorrow, but if the HTML is the same I guess the rest follows though
I just generated the docs without the changes, comitted the results (`reference` and `xml` directories) into a new GIT repository and did the same with the changes applied. The resulting diff is only about the generated timestamps and the following:
```diff diff --git a/xml/Doxyfile.xml b/xml/Doxyfile.xml index 5cb5962..c88d929 100644 --- a/xml/Doxyfile.xml +++ b/xml/Doxyfile.xml @@ -362,7 +362,7 @@ <option id='DOT_FONTNAME' default='yes' type='string'><value><![CDATA[Helvetica]]></value></option> <option id='DOT_FONTSIZE' default='yes' type='int'><value>10</value></option> <option id='DOT_FONTPATH' default='yes' type='string'><value><![CDATA[]]></value></option> - <option id='CLASS_GRAPH' default='no' type='string'><value>TEXT</value></option> + <option id='CLASS_GRAPH' default='yes' type='string'><value>YES</value></option> <option id='COLLABORATION_GRAPH' default='yes' type='bool'><value>YES</value></option> <option id='GROUP_GRAPHS' default='yes' type='bool'><value>YES</value></option> <option id='UML_LOOK' default='yes' type='bool'><value>NO</value></option> ```
So yes, the `CLASS_GRAPH` setting is changed implicitly. But everything in the generated files is identical to before, so it seems to be not relevant for us.
Yeah and the generated *geany-gtkdoc.h* are exactly the same, as expected.
Merged #3719 into master.
github-comments@lists.geany.org