Skip to content

riot.doxyfile: Update and remove deprecated options#20897

Merged
mguetschow merged 1 commit intoRIOT-OS:masterfrom
miri64:doxygen/cleanup/doxyfile
Oct 9, 2024
Merged

riot.doxyfile: Update and remove deprecated options#20897
mguetschow merged 1 commit intoRIOT-OS:masterfrom
miri64:doxygen/cleanup/doxyfile

Conversation

@miri64
Copy link
Copy Markdown
Member

@miri64 miri64 commented Oct 8, 2024

Contribution description

While testing #20896, I noticed that my somewhat recent Doxygen (up-to-date Arch Linux, doxygen version 1.12.0) is complaining about some obsolete options:

warning: Tag 'HTML_TIMESTAMP' at line 1197 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1478 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1752 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 1914 of file '-' 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 2123 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2165 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2172 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2381 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

So I did what the output told me to and ran doxygen -u doc/doxygen/riot.doxyfile. The result is this PR.

Testing procedure

The above warnings should not show up in a doxygen build anymore, the output of the HTML should not change.

Issues/PRs references

Noticed in #20896, but unrelated.

@miri64 miri64 requested review from aabadie and jia200x as code owners October 8, 2024 10:57
@miri64 miri64 requested a review from mguetschow October 8, 2024 10:57
@github-actions github-actions bot added the Area: doc Area: Documentation label Oct 8, 2024
@miri64 miri64 force-pushed the doxygen/cleanup/doxyfile branch from 1ab953b to 1a067e1 Compare October 8, 2024 11:37
@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Oct 8, 2024

Went with doxygen 1.9.1 (the version in riot/riotbuild) instead.

@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Oct 8, 2024
@riot-ci
Copy link
Copy Markdown

riot-ci commented Oct 8, 2024

Murdock results

✔️ PASSED

1a067e1 riot.doxyfile: Update and remove deprecated options

Success Failures Total Runtime
1 0 1 01m:14s

Artifacts

mguetschow
mguetschow approved these changes Oct 9, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've looked through the generated documentation, everything looks as expected. Thanks!

@mguetschow mguetschow enabled auto-merge October 9, 2024 08:07
@mguetschow mguetschow added this pull request to the merge queue Oct 9, 2024
Merged via the queue into RIOT-OS:master with commit 5da0dbe Oct 9, 2024
@miri64 miri64 deleted the doxygen/cleanup/doxyfile branch October 9, 2024 08:29
@benpicco benpicco added this to the Release 2024.10 milestone Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mguetschow mguetschow mguetschow approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

No one assigned

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@miri64 @riot-ci @mguetschow @benpicco