Skip to content

Add a Doxygen filter for .h files#523

Merged
scpeters merged 1 commit intomainfrom
caguero/doxygen_deprecation_c
Feb 6, 2026
Merged

Add a Doxygen filter for .h files#523
scpeters merged 1 commit intomainfrom
caguero/doxygen_deprecation_c

Conversation

@caguero
Copy link
Contributor

@caguero caguero commented Feb 6, 2026

🦟 Bug fix

Summary

Doxygen can not parse the GZ_DEPRECATED() macro in a .h file because the existing filter pattern was only applied to *.hh files, not *.h files.

Here's an example without this patch:

Screenshot from 2026-02-06 15-40-04

And with this patch:

Screenshot from 2026-02-06 15-42-42

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers
  • Was GenAI used to generate this PR? If so, make sure to add "Generated-by" to your commits. (See this policy for more info.)

Generated-by: Remove this if GenAI was not used.

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by and Generated-by messages.

Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
@github-project-automation github-project-automation bot moved this from Inbox to In review in Core development Feb 6, 2026
@scpeters scpeters merged commit 8e87733 into main Feb 6, 2026
9 checks passed
@scpeters scpeters deleted the caguero/doxygen_deprecation_c branch February 6, 2026 21:37
@github-project-automation github-project-automation bot moved this from In review to Done in Core development Feb 6, 2026
@scpeters
Copy link
Member

scpeters commented Feb 6, 2026

https://github.com/Mergifyio backport gz-cmake5 gz-cmake4 gz-cmake3 ign-cmake2

@mergify
Copy link
Contributor

mergify bot commented Feb 6, 2026

backport gz-cmake5 gz-cmake4 gz-cmake3 ign-cmake2

✅ Backports have been created

Details

Cherry-pick of 8e87733 has failed:

On branch mergify/bp/ign-cmake2/pr-523
Your branch is up to date with 'origin/ign-cmake2'.

You are currently cherry-picking commit 8e87733.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   doc/doxygen/api.in

no changes added to commit (use "git add" and/or "git commit -a")

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

mergify bot pushed a commit that referenced this pull request Feb 6, 2026
Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
(cherry picked from commit 8e87733)
mergify bot pushed a commit that referenced this pull request Feb 6, 2026
Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
(cherry picked from commit 8e87733)
mergify bot pushed a commit that referenced this pull request Feb 6, 2026
Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
(cherry picked from commit 8e87733)
mergify bot pushed a commit that referenced this pull request Feb 6, 2026
Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
(cherry picked from commit 8e87733)

# Conflicts:
#	doc/doxygen/api.in
scpeters pushed a commit that referenced this pull request Feb 6, 2026
Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
(cherry picked from commit 8e87733)
j-rivero pushed a commit that referenced this pull request Feb 7, 2026
(cherry picked from commit 8e87733)

Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
Co-authored-by: Carlos Agüero <caguero@osrfoundation.org>
j-rivero pushed a commit that referenced this pull request Feb 7, 2026
(cherry picked from commit 8e87733)

Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
Co-authored-by: Carlos Agüero <caguero@osrfoundation.org>
j-rivero pushed a commit that referenced this pull request Feb 11, 2026
* Add a Doxygen filter for .h files (#523)

Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
(cherry picked from commit 8e87733)

# Conflicts:
#	doc/doxygen/api.in

* Fix conflicts

Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>

---------

Signed-off-by: Carlos Aguero <caguero@osrfoundation.org>
Co-authored-by: Carlos Agüero <caguero@osrfoundation.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants