Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed doxygen excluded files and path stripping #250

Merged
merged 2 commits into from
Jan 12, 2024

Conversation

m-fila
Copy link
Contributor

@m-fila m-fila commented Jan 11, 2024

BEGINRELEASENOTES

  • Fixed doxygen excluded files and path stripping

ENDRELEASENOTES

The documentation generated with doxygen included tests and scripts which aren't part of exposed API

Broken file striping illustration with edm4hep::Vector3f docs:
Was:

edm4hep::Vector3f Class Reference

#include </builds/key4hep/edm4hep/edm4hep/edm4hep/Vector3f.h>
.
.
.
The documentation for this class was generated from the following file:

   - edm4hep/edm4hep/Vector3f.h

fixed:

edm4hep::Vector3f Class Reference

#include <edm4hep/Vector3f.h>
.
.
.
The documentation for this class was generated from the following file:

   - edm4hep/Vector3f.h

Copy link
Contributor

@tmadlener tmadlener left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this.

@tmadlener tmadlener merged commit 562d0a0 into key4hep:main Jan 12, 2024
8 of 9 checks passed
@m-fila m-fila deleted the doxygen_excludes branch May 23, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants