You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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?
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.
The text was updated successfully, but these errors were encountered: