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

ArrayRef defined in APInt.h #36326

Open
llvmbot opened this issue Apr 2, 2018 · 3 comments
Open

ArrayRef defined in APInt.h #36326

llvmbot opened this issue Apr 2, 2018 · 3 comments
Labels
bugzilla Issues migrated from bugzilla confirmed Verified by a second party documentation

Comments

@llvmbot
Copy link
Collaborator

llvmbot commented Apr 2, 2018

Bugzilla Link 36978
Version trunk
OS All
Attachments ArrayRef fix
Reporter LLVM Bugzilla Contributor
CC @bogner

Extended Description

While looking at the Doxygen for ArrayRef, I was surprised to see that it says the class is defined in llvm/ADT/APInt.h at http://llvm.org/doxygen/APInt_8h_source.html#l00033.

However, this looks like a declaration of the class, not a definition. Doxygen seems to be treating template declarations as definitions

A solution for this would be to wrap template declarations in /// \cond ... /// \endcond doc comments which prevent Doxygen from creating documentation for it. Doing that fixes the issue for me.

I'll assign myself to this bug. However, I suspect that other template classes are being affected by this as well, so we should look for them in other headers.

It would also be nice to get some insight as to why Doxygen does this and how we can disable it.
@llvmbot
Copy link
Collaborator Author

llvmbot commented Apr 2, 2018

Submitted patch to the llvm-commits mailing list.

@bogner
Copy link
Contributor

bogner commented Apr 3, 2018

As I mentioned on the mailing list, I think if we're going to do the workaround we should probably apply it more comprehensively. I suppose you could find potential errors and evaluate if they need updating starting with something like this:

git grep '^template .* class .*;'

Notably SmallVectorImpl will probably still say it's in APFloat if we apply the patch as is.

I guess the only real alternative is to file a bug on doxygen and wait?

@llvmbot
Copy link
Collaborator Author

llvmbot commented Apr 4, 2018

I submitted a bug at https://bugzilla.gnome.org/show_bug.cgi?id=794959. Worst case scenario I can grep all the template declarations and submit a new patch.

@llvmbot llvmbot transferred this issue from llvm/llvm-bugzilla-archive Dec 10, 2021
@llvmbot llvmbot added the confirmed Verified by a second party label Jan 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bugzilla Issues migrated from bugzilla confirmed Verified by a second party documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bogner @llvmbot