refactor: Introduce DocComment type (#146)

Author: varungandhi-src

indexer/Indexer.cc

@@ -284,8 +284,8 @@ void TuIndexer::saveEnumConstantDecl(
   auto symbol = optSymbol.value();
 
   scip::SymbolInformation symbolInfo;
-  for (auto &docComment : this->tryGetDocComment(enumConstantDecl)) {
-    *symbolInfo.add_documentation() = std::move(docComment.Text);
+  for (auto &docComment : this->tryGetDocComment(enumConstantDecl).lines) {
+    *symbolInfo.add_documentation() = std::move(docComment);
   }
 
   ENFORCE(enumConstantDecl.getBeginLoc() == enumConstantDecl.getLocation());
@@ -307,8 +307,8 @@ void TuIndexer::saveFieldDecl(const clang::FieldDecl &fieldDecl) {
     return;
   }
   scip::SymbolInformation symbolInfo{};
-  for (auto &docComment : this->tryGetDocComment(fieldDecl)) {
-    *symbolInfo.add_documentation() = std::move(docComment.Text);
+  for (auto &docComment : this->tryGetDocComment(fieldDecl).lines) {
+    *symbolInfo.add_documentation() = std::move(docComment);
   }
   this->saveDefinition(optSymbol.value(), fieldDecl.getLocation(), symbolInfo);
 }
@@ -329,8 +329,8 @@ void TuIndexer::saveFunctionDecl(const clang::FunctionDecl &functionDecl) {
 
   if (functionDecl.isPure() || functionDecl.isThisDeclarationADefinition()) {
     scip::SymbolInformation symbolInfo{};
-    for (auto &docComment : this->tryGetDocComment(functionDecl)) {
-      *symbolInfo.add_documentation() = std::move(docComment.Text);
+    for (auto &docComment : this->tryGetDocComment(functionDecl).lines) {
+      *symbolInfo.add_documentation() = std::move(docComment);
     }
     if (auto *cxxMethodDecl =
             llvm::dyn_cast<clang::CXXMethodDecl>(&functionDecl)) {
@@ -493,8 +493,8 @@ void TuIndexer::saveTagDecl(const clang::TagDecl &tagDecl) {
   }
 
   scip::SymbolInformation symbolInfo;
-  for (auto &docComment : this->tryGetDocComment(tagDecl)) {
-    *symbolInfo.add_documentation() = std::move(docComment.Text);
+  for (auto &docComment : this->tryGetDocComment(tagDecl).lines) {
+    *symbolInfo.add_documentation() = std::move(docComment);
   }
 
   if (auto *cxxRecordDecl = llvm::dyn_cast<clang::CXXRecordDecl>(&tagDecl)) {
@@ -579,8 +579,8 @@ void TuIndexer::saveTypedefNameDecl(
     return;
   }
   scip::SymbolInformation symbolInfo{};
-  for (auto &docComment : this->tryGetDocComment(typedefNameDecl)) {
-    *symbolInfo.add_documentation() = std::move(docComment.Text);
+  for (auto &docComment : this->tryGetDocComment(typedefNameDecl).lines) {
+    *symbolInfo.add_documentation() = std::move(docComment);
   }
   this->saveDefinition(*optSymbol, typedefNameDecl.getLocation(),
                        std::move(symbolInfo));
@@ -606,8 +606,8 @@ void TuIndexer::saveVarDecl(const clang::VarDecl &varDecl) {
       return;
     }
     scip::SymbolInformation symbolInfo{};
-    for (auto &docComment : this->tryGetDocComment(varDecl)) {
-      *symbolInfo.add_documentation() = std::move(docComment.Text);
+    for (auto &docComment : this->tryGetDocComment(varDecl).lines) {
+      *symbolInfo.add_documentation() = std::move(docComment);
     }
     this->saveDefinition(optSymbol.value(), varDecl.getLocation(), symbolInfo);
   }
@@ -763,17 +763,20 @@ checkIfCommentBelongsToPreviousEnumCase(const clang::Decl &decl,
 
 namespace scip_clang {
 
-std::vector<clang::RawComment::CommentLine>
-TuIndexer::tryGetDocComment(const clang::Decl &decl) const {
+DocComment TuIndexer::tryGetDocComment(const clang::Decl &decl) const {
   auto &astContext = decl.getASTContext();
   // FIXME(def: hovers, issue:
   // https://github.com/sourcegraph/scip-clang/issues/96)
   if (auto *rawComment = astContext.getRawCommentForAnyRedecl(&decl)) {
     if (::checkIfCommentBelongsToPreviousEnumCase(decl, *rawComment)) {
       return {};
     }
-    return rawComment->getFormattedLines(this->sourceManager,
-                                         astContext.getDiagnostics());
+    DocComment out{};
+    for (auto &line : rawComment->getFormattedLines(
+             this->sourceManager, astContext.getDiagnostics())) {
+      out.lines.emplace_back(std::move(line.Text));
+    }
+    return out;
   }
   return {};
 }

indexer/Indexer.h

@@ -201,6 +201,10 @@ struct PartialDocument {
   absl::flat_hash_map<std::string_view, scip::SymbolInformation> symbolInfos;
 };
 
+struct DocComment {
+  std::vector<std::string> lines;
+};
+
 class TuIndexer final {
   const clang::SourceManager &sourceManager;
   const clang::LangOptions &langOptions;
@@ -264,8 +268,7 @@ class TuIndexer final {
                                   clang::SourceLocation loc,
                                   int32_t allRoles = 0);
 
-  std::vector<clang::RawComment::CommentLine>
-  tryGetDocComment(const clang::Decl &) const;
+  DocComment tryGetDocComment(const clang::Decl &) const;
 };
 
 } // namespace scip_clang