Add a warning about almost-Doxygen trailing comments: //< and /*< ... */

llvm-svn: 159001

Author: gribozavr

clang/include/clang/Basic/DiagnosticGroups.td

@@ -57,6 +57,7 @@ def DeprecatedImplementations :DiagGroup<"deprecated-implementations">;
 def : DiagGroup<"disabled-optimization">;
 def : DiagGroup<"discard-qual">;
 def : DiagGroup<"div-by-zero">;
+def Doxygen : DiagGroup<"doxygen">;
 def EmptyBody : DiagGroup<"empty-body">;
 def ExtraTokens : DiagGroup<"extra-tokens">;
 

clang/include/clang/Basic/DiagnosticSemaKinds.td

@@ -5665,5 +5665,10 @@ def err_module_private_definition : Error<
   "definition of %0 must be imported before it is required">;
 }
 
+let CategoryName = "Documentation Issue" in {
+def warn_not_a_doxygen_trailing_member_comment : Warning<
+  "not a Doxygen trailing comment">, InGroup<Doxygen>;
+} // end of documentation issue category
+
 } // end of sema component.
 

clang/lib/Sema/Sema.cpp

@@ -1016,6 +1016,24 @@ LambdaScopeInfo *Sema::getCurLambda() {
 
 void Sema::ActOnComment(SourceRange Comment) {
   RawComment RC(SourceMgr, Comment);
+  if (RC.isAlmostTrailingComment()) {
+    SourceRange MagicMarkerRange(Comment.getBegin(),
+                                 Comment.getBegin().getLocWithOffset(3));
+    StringRef MagicMarkerText;
+    switch (RC.getKind()) {
+    case RawComment::CK_OrdinaryBCPL:
+      MagicMarkerText = "///<";
+      break;
+    case RawComment::CK_OrdinaryC:
+      MagicMarkerText = "/**<";
+      break;
+    default:
+      llvm_unreachable("if this is an almost Doxygen comment, "
+                       "it should be ordinary");
+    }
+    Diag(Comment.getBegin(), diag::warn_not_a_doxygen_trailing_member_comment) <<
+      FixItHint::CreateReplacement(MagicMarkerRange, MagicMarkerText);
+  }
   Context.addComment(RC);
 }
 

clang/test/Analysis/retain-release.m

@@ -753,7 +753,7 @@ - (OtherRef)_copyOtherRef {
 @end
 
 //===----------------------------------------------------------------------===//
-//<rdar://problem/6320065> false positive - init method returns an object
+// <rdar://problem/6320065> false positive - init method returns an object
 // owned by caller
 //===----------------------------------------------------------------------===//
 

clang/test/Sema/doxygen-comments.c

@@ -0,0 +1,14 @@
+// RUN: %clang_cc1 -fsyntax-only -verify %s
+// RUN: %clang_cc1 -fsyntax-only -fdiagnostics-parseable-fixits %s 2>&1 | FileCheck %s
+// RUN: cp %s %t
+// RUN: %clang_cc1 -fsyntax-only -fixit %t
+// RUN: %clang_cc1 -fsyntax-only -Werror %t
+
+struct a {
+  int x; //< comment // expected-warning {{not a Doxygen trailing comment}}
+  int y; /*< comment */ // expected-warning {{not a Doxygen trailing comment}}
+};
+
+// CHECK: fix-it:"{{.*}}":{8:10-8:13}:"///<"
+// CHECK: fix-it:"{{.*}}":{9:10-9:13}:"/**<"
+