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
Try to hide fwd include in doxygen #8224
Conversation
Starting build on |
Build failed on ROOT-fedora31/noimt. Failing tests: |
Build failed on ROOT-debian10-i386/cxx14. Failing tests: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand the PR now fixes the documentation by having the definition of the typedef's directly in Vector.h
However, we are repeating the code, and I am afraid this could cause a problem.
I do not see really an advantage of this. It will add a link to Vector4d.h that anyway does not contain the definition of the templated class that is in LorentzVector.h
The documentation of the class is directly accessible from the typedef definition.
I would then leave the current status and close this PR
Which one? As long as users see the template, |
The problem could be that one changes the template class and the typedef declaration in We have this now https://root.cern.ch/doc/master/namespaceROOT_1_1Math.html#a39def91bfd150148b1534d8ae665b145 |
Simply include |
This is exactly what is now in master and this PR is changing this |
Try to better fix #8051
In the files
Vector2-4-3D.h
the definitions in the fwd files are now duplicated,in order typedef like
PtEtaPhiMVector
appears defined inVector4D.h
in the ref guideas it is the file users should include.