[llvm-bugs] [Bug 38905] New: -Wdocumentation generates error with @see @ref

via llvm-bugs llvm-bugs at lists.llvm.org
Tue Sep 11 23:45:37 PDT 2018


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

            Bug ID: 38905
           Summary: -Wdocumentation generates error with @see @ref
           Product: clang
           Version: 3.9
          Hardware: PC
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: P
         Component: C++
          Assignee: unassignedclangbugs at nondot.org
          Reporter: rose at r2air.com
                CC: dgregor at apple.com, llvm-bugs at lists.llvm.org

clang++ generates an error on a valid doxygen block that uses the @see tag.

Steps to reproduce:

$ cat docbug.cc 

/**
 * @see @ref FOO
 */
int function() {
  return 0;
}

$ clang++ -Werror -Wdocumentation -c docbug.cc -o docbug.o

Actual result:

docbug.cc:3:8: warning: empty paragraph passed to '@see' command
[-Wdocumentation]
 * @see @ref FOO

Expected result:

<no error>

Doxygen (tested versions 1.8.11 and 1.8.13) interpret this as valid markup.

-- 
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/20180912/d60d61c1/attachment.html>


More information about the llvm-bugs mailing list