Update for Doxygen 1.9.5 #119
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
This MR updates the code and CI job to use a newer version of Doxygen, 1.9.5. It was pointed out that even after #118 there were still some errors showing up in the docs when using this version, so those should be resolved now.
Basically, Doxygen 1.9.5 made four changes that we need to handle:
doxygen -u
.@param
is added to an entity that does not have parameters. In particular, this means thatmbed::Callback<...>
declarations cannot take parameters. I emulated the style of parameters using<br>
and\c
tags.@return
tag is applied to something that is not a function. This helped find several errors in the docs where documentation was attached to the wrong entities.I've updated the code to account for all of these things and fix the warnings. Here's what the new pseudo-parameter formatting looks like:

It's honestly not half bad, IMO.
Impact of changes
Migration actions required
Documentation
(this is a docs update)
Pull request type
Test results
Reviewers