[llvm-bugs] [Bug 37813] New: -Wdocumentation-unknown-command does not recognize @private

via llvm-bugs llvm-bugs at lists.llvm.org
Fri Jun 15 06:44:58 PDT 2018


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

            Bug ID: 37813
           Summary: -Wdocumentation-unknown-command does not recognize
                    @private
           Product: clang
           Version: 6.0
          Hardware: PC
                OS: Linux
            Status: NEW
          Severity: enhancement
          Priority: P
         Component: -New Bugs
          Assignee: unassignedclangbugs at nondot.org
          Reporter: oliverst at online.de
                CC: llvm-bugs at lists.llvm.org

This code

/// @private
int main() {
    return 0;
}

produces the following warning

/mnt/c/clion/example/src/main.cpp:1:5: error: unknown command tag name
[-Werror,-Wdocumentation-unknown-command]
/// @private
    ^~~~~~~~

Unfortunately you cannot use -fcomment-block-commands=private to silence the
wrning since that tag can used without any other information leading to this
warning:

/mnt/c/clion/example/src/main.cpp:1:13: error: empty paragraph passed to
'@private' command [-Werror,-Wdocumentation]
/// @private
    ~~~~~~~~^

The tag is defined by doxygen
https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdprivate

-- 
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/20180615/55ec24d7/attachment.html>


More information about the llvm-bugs mailing list