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.

Sign up for GitHub

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

Jump to bottom

[VecOps] Make free functions in VecOps better visible #7699

Closed
stwunsch opened this issue Mar 25, 2021 · 6 comments · Fixed by #7731
Closed

[VecOps] Make free functions in VecOps better visible #7699

stwunsch opened this issue Mar 25, 2021 · 6 comments · Fixed by #7731
Assignees
@couet
Labels
fixathon This issue can be tackled at a ROOT fixathon improvement in:Math Libraries
Projects
Fixed in 6.32.00

Comments

@stwunsch
Copy link
Contributor

  • If I understood correctly we have to add the functions correctly to a VecOps group in Doxygen so that they show up if you use the search.
  • Add more information in the \defgroup section.
@github-actions github-actions bot added this to Needs triage in Triage Mar 25, 2021
stwunsch added a commit to stwunsch/root that referenced this issue Mar 29, 2021
@stwunsch
[Doc][VecOps][NFC] Add all functions in VecOps to the Doxygen group
b8aaf3c 
Fixes root-project#7699
@stwunsch stwunsch mentioned this issue Mar 29, 2021
Merged
Triage automation moved this from Needs triage to Closed Mar 30, 2021
stwunsch added a commit that referenced this issue Mar 30, 2021
@stwunsch
[Doc][VecOps][NFC] Add all functions in VecOps to the Doxygen group
1d04191 
Fixes #7699
@stwunsch
Copy link
Contributor Author

Reopening, we have to check that the PR behaves as expected.

@stwunsch stwunsch reopened this Mar 30, 2021
@stwunsch
Copy link
Contributor Author

@eguiraud What do you thinks, good like that? -> https://root.cern/doc/master/group__vecops.html

@stwunsch
Copy link
Contributor Author

I've no idea how to make the preproc macros look nicer or even expand them properly :/

@eguiraud
Copy link
Member

eguiraud commented Apr 6, 2021

We can either "expand" the macros manually (i.e. get rid of the macros), or maybe better we can explicitly write doxygen strings for them using the \fn Doxygen command and similar

@stwunsch
Copy link
Contributor Author

stwunsch commented Apr 6, 2021

Expanding the macros would result in a massive code duplication, see https://github.com/root-project/root/blob/master/math/vecops/inc/ROOT/RVec.hxx#L607-L695

So adding manual docs would be the solution, i guess!

@hahnjo hahnjo removed this from Closed in Triage Jul 19, 2021
@guitargeek guitargeek assigned couet and unassigned stwunsch Dec 18, 2023
@vepadulano vepadulano added the fixathon This issue can be tackled at a ROOT fixathon label Feb 5, 2024
@dpiparo dpiparo added this to Issues in Fixed in 6.32.00 via automation Apr 25, 2024
@dpiparo
Copy link
Member

dpiparo commented Apr 25, 2024

Fixed by #15277

@dpiparo dpiparo closed this as completed Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@couet couet

Labels
fixathon This issue can be tackled at a ROOT fixathon improvement in:Math Libraries
Projects
Fixathon
Status: Done
Fixed in 6.32.00
Issues
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Doc][VecOps][NFC] Add all functions in VecOps to the Doxygen group stwunsch/root
5 participants
@couet @stwunsch @dpiparo @eguiraud @vepadulano