diff options
-rw-r--r-- | clang/include/clang/Basic/DiagnosticCommentKinds.td | 6 | ||||
-rw-r--r-- | clang/lib/AST/CommentParser.cpp | 6 | ||||
-rw-r--r-- | clang/test/Sema/warn-documentation.cpp | 42 |
3 files changed, 54 insertions, 0 deletions
diff --git a/clang/include/clang/Basic/DiagnosticCommentKinds.td b/clang/include/clang/Basic/DiagnosticCommentKinds.td index fcda3f3a211..d8ce258d47d 100644 --- a/clang/include/clang/Basic/DiagnosticCommentKinds.td +++ b/clang/include/clang/Basic/DiagnosticCommentKinds.td @@ -153,6 +153,12 @@ def warn_doc_deprecated_not_sync : Warning< 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< diff --git a/clang/lib/AST/CommentParser.cpp b/clang/lib/AST/CommentParser.cpp index c7f8aa7e16a..29983b0a16c 100644 --- a/clang/lib/AST/CommentParser.cpp +++ b/clang/lib/AST/CommentParser.cpp @@ -422,6 +422,12 @@ InlineCommandComment *Parser::parseInlineCommand() { 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(); diff --git a/clang/test/Sema/warn-documentation.cpp b/clang/test/Sema/warn-documentation.cpp index 5083f686338..df7e189514a 100644 --- a/clang/test/Sema/warn-documentation.cpp +++ b/clang/test/Sema/warn-documentation.cpp @@ -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. /** |