Author: gribozavr Date: Mon Aug 5 01:05:16 2019 New Revision: 367809 URL: http://llvm.org/viewvc/llvm-project?rev=367809&view=rev Log: Adds a warning when an inline Doxygen comment has no argument
Summary: It warns for for comments like /** \pre \em */ where \em has no argument This warning is enabled with the -Wdocumentation option. Reviewers: gribozavr, rsmith Reviewed By: gribozavr Subscribers: cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D64696 Patch by Mark de Wever. Modified: cfe/trunk/include/clang/Basic/DiagnosticCommentKinds.td cfe/trunk/lib/AST/CommentParser.cpp cfe/trunk/test/Sema/warn-documentation.cpp Modified: cfe/trunk/include/clang/Basic/DiagnosticCommentKinds.td URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/DiagnosticCommentKinds.td?rev=367809&r1=367808&r2=367809&view=diff ============================================================================== --- cfe/trunk/include/clang/Basic/DiagnosticCommentKinds.td (original) +++ cfe/trunk/include/clang/Basic/DiagnosticCommentKinds.td Mon Aug 5 01:05:16 2019 @@ -153,6 +153,12 @@ def warn_doc_deprecated_not_sync : Warni def note_add_deprecation_attr : Note< "add a deprecation attribute to the declaration to silence this warning">; +// inline contents commands + +def warn_doc_inline_contents_no_argument : Warning< + "'%select{\\|@}0%1' command does not have an argument">, + InGroup<Documentation>, DefaultIgnore; + // verbatim block commands def warn_verbatim_block_end_without_start : Warning< Modified: cfe/trunk/lib/AST/CommentParser.cpp URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/AST/CommentParser.cpp?rev=367809&r1=367808&r2=367809&view=diff ============================================================================== --- cfe/trunk/lib/AST/CommentParser.cpp (original) +++ cfe/trunk/lib/AST/CommentParser.cpp Mon Aug 5 01:05:16 2019 @@ -422,6 +422,12 @@ InlineCommandComment *Parser::parseInlin IC = S.actOnInlineCommand(CommandTok.getLocation(), CommandTok.getEndLocation(), CommandTok.getCommandID()); + + Diag(CommandTok.getEndLocation().getLocWithOffset(1), + diag::warn_doc_inline_contents_no_argument) + << CommandTok.is(tok::at_command) + << Traits.getCommandInfo(CommandTok.getCommandID())->Name + << SourceRange(CommandTok.getLocation(), CommandTok.getEndLocation()); } Retokenizer.putBackLeftoverTokens(); Modified: cfe/trunk/test/Sema/warn-documentation.cpp URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/test/Sema/warn-documentation.cpp?rev=367809&r1=367808&r2=367809&view=diff ============================================================================== --- cfe/trunk/test/Sema/warn-documentation.cpp (original) +++ cfe/trunk/test/Sema/warn-documentation.cpp Mon Aug 5 01:05:16 2019 @@ -1044,6 +1044,48 @@ template <> template <typename B> void test_attach38<int>::test_attach39(int, B); +// The inline comments expect a string after the command. +// expected-warning@+1 {{'\a' command does not have an argument}} +/// \a +int test_inline_no_argument_a_bad(int); + +/// \a A +int test_inline_no_argument_a_good(int); + +// expected-warning@+1 {{'@b' command does not have an argument}} +/// @b +int test_inline_no_argument_b_bad(int); + +/// @b A +int test_inline_no_argument_b_good(int); + +// expected-warning@+1 {{'\c' command does not have an argument}} +/// \c +int test_inline_no_argument_c_bad(int); + +/// \c A +int test_inline_no_argument_c_good(int); + +// expected-warning@+1 {{'\e' command does not have an argument}} +/// \e +int test_inline_no_argument_e_bad(int); + +/// \e A +int test_inline_no_argument_e_good(int); + +// expected-warning@+1 {{'\em' command does not have an argument}} +/// \em +int test_inline_no_argument_em_bad(int); + +/// \em A +int test_inline_no_argument_em_good(int); + +// expected-warning@+1 {{'\p' command does not have an argument}} +/// \p +int test_inline_no_argument_p_bad(int); + +/// \p A +int test_inline_no_argument_p_good(int); // PR13411, reduced. We used to crash on this. /** _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits