[llvm-bugs] [Bug 37814] New: -Wdocumentation doesn't support Markdown

via llvm-bugs llvm-bugs at lists.llvm.org
Fri Jun 15 06:53:28 PDT 2018


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

            Bug ID: 37814
           Summary: -Wdocumentation doesn't support Markdown
           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

/// documentation
/// @code
///     std::cout << "test\n";
/// @endcode
///
/// code:
///
///     std::cout << "test\n";
///
/// \return exitcode
int main() {
    return 0;
}

produces the following message since the Markdown intendation-based code block
is not being recognized

/mnt/c/clion/example/src/main.cpp:8:27: error: unknown command tag name
[-Werror,-Wdocumentation-unknown-command]
///     std::cout << "test\n";
                          ^~

Both blocks generate code blocks in the documentation.

doxygen 1.8.0 added support for Markdown
https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_codeblock

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


More information about the llvm-bugs mailing list