[LLVMbugs] [Bug 17828] New: -Wdocumentation does not count @code / @endcode blocks as part of a paragraph.

bugzilla-daemon at llvm.org bugzilla-daemon at llvm.org
Tue Nov 5 19:25:12 PST 2013


            Bug ID: 17828
           Summary: -Wdocumentation does not count @code / @endcode blocks
                    as part of a paragraph.
           Product: clang
           Version: trunk
          Hardware: PC
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: P
         Component: Frontend
          Assignee: unassignedclangbugs at nondot.org
          Reporter: toojays at toojays.net
                CC: llvmbugs at cs.uiuc.edu
    Classification: Unclassified

If the content of a Doxygen paragraph is entirely contained within an
@code/@endcode block, Clang treats the paragraph as being empty, and
incorrectly warns about it.

jscott at saaz:~$ cat /tmp/foo.c
 * Some function on x and y.
 * @param[in] x The x.
 * @param[in] y The y.
 * @pre @code x < y @endcode.

void f (int x, int y)
  (void) x;
  (void) y;

jscott at saaz:~$ clang -Wdocumentation -c /tmp/foo.c 
/tmp/foo.c:6:8: warning: empty paragraph passed to '@pre' command
 * @pre @code x < y @endcode.
1 warning generated.

This is with a Clang snapshot from the llvm Debian snapshots repo at version

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/20131106/4f23a6e9/attachment.html>

More information about the llvm-bugs mailing list