[llvm-bugs] [Bug 36978] New: ArrayRef defined in APInt.h

[via llvm-bugs]

https://bugs.llvm.org/show_bug.cgi?id=36978

            Bug ID: 36978
           Summary: ArrayRef defined in APInt.h
           Product: Documentation
           Version: trunk
          Hardware: All
                OS: All
            Status: NEW
          Severity: enhancement
          Priority: P
         Component: Doxygen
          Assignee: unassignedbugs at nondot.org
          Reporter: taylor at hansenfamily.us
                CC: llvm-bugs at lists.llvm.org

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.

-- 
You are receiving this mail because:
You are on the CC list for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20180402/1b968322/attachment.html>