http://llvm.org/bugs/show_bug.cgi?id=14295
Bug #: 14295
Summary: -Wdocumentation warns on duplicate \return comments,
but the doxygen docs allow that
Product: clang
Version: unspecified
Platform: PC
OS/Version: All
Status: NEW
Severity: enhancement
Priority: P
Component: Frontend
AssignedTo: [email protected]
ReportedBy: [email protected]
CC: [email protected]
Classification: Unclassified
I just tried -Wdocumentation on a project that had a comment like this:
/// @return the number of processors on the machine. Useful for an initial
/// guess for how many jobs to run in parallel. @return 0 on error.
int GetProcessorCount();
http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn says "Multiple
adjacent \return commands will be joined into a single paragraph.", but
-Wdocumentation says:
src/util.h:61:51: warning: duplicated command '\return' [-Wdocumentation]
/// guess for how many jobs to run in parallel. @return 0 on error.
~^~~~~~~~~~~~~~~~~~
src/util.h:60:6: note: previous command '\return' here
/// @return the number of processors on the machine. Useful for an initial
~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.
It seems like clang shouldn't warn about this.
--
Configure bugmail: http://llvm.org/bugs/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.
_______________________________________________
LLVMbugs mailing list
[email protected]
http://lists.cs.uiuc.edu/mailman/listinfo/llvmbugs
