fix: Treat all kinds of comments as doc comments (#325)

Author: varungandhi-src

indexer/Worker.cc

@@ -44,6 +44,7 @@ class IndexerFrontendAction : public clang::ASTFrontendAction {
   std::unique_ptr<clang::ASTConsumer>
   CreateASTConsumer(clang::CompilerInstance &compilerInstance,
                     llvm::StringRef filepath) override {
+    compilerInstance.getLangOpts().CommentOpts.ParseAllComments = true;
     auto &preprocessor = compilerInstance.getPreprocessor();
     auto callbacks = std::make_unique<IndexerPreprocessorWrapper>(
         compilerInstance.getSourceManager(), this->preprocessorOptions,

test/index/docs/docs.cc

@@ -0,0 +1,18 @@
+// format-options: showDocs
+
+/// Dumhdurum!
+enum class Apink {
+  /** Leader
+   * Lead Dancer */
+  Chorong,
+  // Vocalist
+  Bomi,
+  Eunji,  // Main Vocalist
+          // From Busan
+  /* Departed
+   * :( */
+  Naeun,
+  Namjoo, /* Vocalist */
+  //! Maknae
+  Hayoung,
+};

test/index/docs/docs.snapshot.cc

@@ -0,0 +1,45 @@
+  // format-options: showDocs
+//^^^^^^^^^^^^^^^^^^^^^^^^^^^ definition [..] `<file>/docs.cc`/
+//documentation
+//| File: docs.cc
+  
+  /// Dumhdurum!
+  enum class Apink {
+//           ^^^^^ definition [..] Apink#
+//           documentation
+//           | Dumhdurum!
+    /** Leader
+     * Lead Dancer */
+    Chorong,
+//  ^^^^^^^ definition [..] Apink#Chorong.
+//  documentation
+//  | Leader
+//  | Lead Dancer
+    // Vocalist
+    Bomi,
+//  ^^^^ definition [..] Apink#Bomi.
+//  documentation
+//  | Vocalist
+    Eunji,  // Main Vocalist
+//  ^^^^^ definition [..] Apink#Eunji.
+//  documentation
+//  | Main Vocalist
+//  | From Busan
+            // From Busan
+    /* Departed
+     * :( */
+    Naeun,
+//  ^^^^^ definition [..] Apink#Naeun.
+//  documentation
+//  | Departed
+//  | :(
+    Namjoo, /* Vocalist */
+//  ^^^^^^ definition [..] Apink#Namjoo.
+//  documentation
+//  | Vocalist
+    //! Maknae
+    Hayoung,
+//  ^^^^^^^ definition [..] Apink#Hayoung.
+//  documentation
+//  | Maknae
+  };

test/index/types/types.snapshot.cc

@@ -33,12 +33,13 @@
   enum D {
 //     ^ definition [..] D#
 //     documentation
-//     | No documentation available.
+//     | Old MacDonald had a farm
+//     | Ee i ee i o
     // And on his farm he had some cows
     D1,
 //  ^^ definition [..] D1.
 //  documentation
-//  | No documentation available.
+//  | And on his farm he had some cows
   };
 
   /// Ee i ee i oh
@@ -91,7 +92,7 @@
       F1,
 //    ^^ definition [..] has_anon_enum/F1.
 //    documentation
-//    | No documentation available.
+//    | Here a moo, there a moo
       /** Everywhere a moo-moo */
       F2 = E2
 //    ^^ definition [..] has_anon_enum/F2.
@@ -193,7 +194,7 @@
   enum class PartiallyDocumented {
 //           ^^^^^^^^^^^^^^^^^^^ definition [..] PartiallyDocumented#
 //           documentation
-//           | No documentation available.
+//           | Regression test for https://github.com/sourcegraph/scip-clang/issues/105
     /// :smugcat:
     Documented,
 //  ^^^^^^^^^^ definition [..] PartiallyDocumented#Documented.