From 2aa5cf412c9a56aba1e3a7b04ca18499a2b83b20 Mon Sep 17 00:00:00 2001 From: Fariborz Jahanian Date: Mon, 18 Mar 2013 23:45:52 +0000 Subject: [PATCH] documentation comment parsing. Added couple of top-level HeaderDoc tags @functiongroup and @methodgroup to doc. tags recognized. // rdar://12379114 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@177358 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/clang/AST/CommentCommands.td | 2 ++ include/clang/Basic/DiagnosticCommentKinds.td | 7 ++++--- lib/AST/CommentSema.cpp | 10 ++++++++-- test/Sema/warn-documentation.m | 14 ++++++++++++++ 4 files changed, 28 insertions(+), 5 deletions(-) diff --git a/include/clang/AST/CommentCommands.td b/include/clang/AST/CommentCommands.td index e217834227..9587ace87c 100644 --- a/include/clang/AST/CommentCommands.td +++ b/include/clang/AST/CommentCommands.td @@ -213,7 +213,9 @@ def Union : RecordLikeDeclarationVerbatimLineCommand<"union">; def Category : DeclarationVerbatimLineCommand<"category">; def Template : DeclarationVerbatimLineCommand<"template">; def Function : FunctionDeclarationVerbatimLineCommand<"function">; +def FunctionGroup : FunctionDeclarationVerbatimLineCommand<"functiongroup">; def Method : FunctionDeclarationVerbatimLineCommand<"method">; +def MethodGroup : FunctionDeclarationVerbatimLineCommand<"methodgroup">; def Callback : FunctionDeclarationVerbatimLineCommand<"callback">; def Const : DeclarationVerbatimLineCommand<"const">; def Constant : DeclarationVerbatimLineCommand<"constant">; diff --git a/include/clang/Basic/DiagnosticCommentKinds.td b/include/clang/Basic/DiagnosticCommentKinds.td index 7682b85a13..3880e0e5b4 100644 --- a/include/clang/Basic/DiagnosticCommentKinds.td +++ b/include/clang/Basic/DiagnosticCommentKinds.td @@ -74,9 +74,10 @@ def warn_doc_param_not_attached_to_a_function_decl : Warning< InGroup, DefaultIgnore; def warn_doc_function_method_decl_mismatch : Warning< - "'%select{\\|@}0%select{function|method|callback}1' command should be " - "used in a comment attached to " - "%select{a function|an Objective-C method|a pointer to function}2 declaration">, + "'%select{\\|@}0%select{function|functiongroup|method|methodgroup|callback}1' " + "command should be used in a comment attached to " + "%select{a function|a function|an Objective-C method|an Objective-C method|" + "a pointer to function}2 declaration">, InGroup, DefaultIgnore; def warn_doc_api_container_decl_mismatch : Warning< diff --git a/lib/AST/CommentSema.cpp b/lib/AST/CommentSema.cpp index e6367c9755..e0138d5f3f 100644 --- a/lib/AST/CommentSema.cpp +++ b/lib/AST/CommentSema.cpp @@ -101,11 +101,17 @@ void Sema::checkFunctionDeclVerbatimLine(const BlockCommandComment *Comment) { case CommandTraits::KCI_function: DiagSelect = !isAnyFunctionDecl() ? 1 : 0; break; + case CommandTraits::KCI_functiongroup: + DiagSelect = !isAnyFunctionDecl() ? 2 : 0; + break; case CommandTraits::KCI_method: - DiagSelect = !isObjCMethodDecl() ? 2 : 0; + DiagSelect = !isObjCMethodDecl() ? 3 : 0; + break; + case CommandTraits::KCI_methodgroup: + DiagSelect = !isObjCMethodDecl() ? 4 : 0; break; case CommandTraits::KCI_callback: - DiagSelect = !isFunctionPointerVarDecl() ? 3 : 0; + DiagSelect = !isFunctionPointerVarDecl() ? 5 : 0; break; default: DiagSelect = 0; diff --git a/test/Sema/warn-documentation.m b/test/Sema/warn-documentation.m index 98c4993561..1e3acf1d72 100644 --- a/test/Sema/warn-documentation.m +++ b/test/Sema/warn-documentation.m @@ -123,6 +123,20 @@ typedef id OBJ; } @end +// rdar://12379114 +// expected-warning@+4 {{'@methodgroup' command should be used in a comment attached to an Objective-C method declaration}} +// expected-warning@+6 {{'@method' command should be used in a comment attached to an Objective-C method declaratio}} +@interface rdar12379114 +/*! + @methodgroup Creating a request +*/ +/*! + @method initWithTimeout is the 2nd method +*/ +typedef unsigned int NSTimeInterval; +- (id)initWithTimeout:(NSTimeInterval)timeout; +@end + // expected-warning@+2 {{'@protocol' command should not be used in a comment attached to a non-protocol declaration}} /*! @protocol PROTO