[clang-doc] make a helper function for creating file definition

Author: hulxv

clang-tools-extra/clang-doc/HTMLGenerator.cpp

@@ -530,6 +530,13 @@ writeFileDefinition(const ClangDocContext &CDCtx, const Location &L) {
   return Node;
 }
 
+static void createFileDefinition(std::vector<std::unique_ptr<TagNode>> &Out,
+                                 const ClangDocContext &CDCtx,
+                                 const std::optional<Location> &DefLoc) {
+  if (DefLoc)
+    Out.emplace_back(writeFileDefinition(CDCtx, *DefLoc));
+}
+
 static std::vector<std::unique_ptr<TagNode>>
 genHTML(const Index &Index, StringRef InfoPath, bool IsOutermostList);
 
@@ -749,8 +756,7 @@ genHTML(const EnumInfo &I, const ClangDocContext &CDCtx) {
 
   Out.emplace_back(std::move(Table));
 
-  if (I.DefLoc)
-    Out.emplace_back(writeFileDefinition(CDCtx, *I.DefLoc));
+  createFileDefinition(Out, CDCtx, I.DefLoc);
 
   std::string Description;
   if (!I.Description.empty())
@@ -793,8 +799,7 @@ genHTML(const FunctionInfo &I, const ClangDocContext &CDCtx,
   }
   FunctionHeader->Children.emplace_back(std::make_unique<TextNode>(")"));
 
-  if (I.DefLoc)
-    Out.emplace_back(writeFileDefinition(CDCtx, *I.DefLoc));
+  createFileDefinition(Out, CDCtx, I.DefLoc);
 
   std::string Description;
   if (!I.Description.empty())
@@ -855,8 +860,7 @@ genHTML(const RecordInfo &I, Index &InfoIndex, const ClangDocContext &CDCtx,
   InfoTitle = (getTagType(I.TagType) + " " + I.Name).str();
   Out.emplace_back(std::make_unique<TagNode>(HTMLTag::TAG_H1, InfoTitle));
 
-  if (I.DefLoc)
-    Out.emplace_back(writeFileDefinition(CDCtx, *I.DefLoc));
+  createFileDefinition(Out, CDCtx, I.DefLoc);
 
   std::string Description;
   if (!I.Description.empty())

clang-tools-extra/clang-doc/MDGenerator.cpp

@@ -12,6 +12,7 @@
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/FormatVariadic.h"
 #include "llvm/Support/Path.h"
+#include "llvm/Support/raw_ostream.h"
 #include <string>
 
 using namespace llvm;
@@ -67,6 +68,13 @@ static void writeFileDefinition(const ClangDocContext &CDCtx, const Location &L,
   OS << "\n\n";
 }
 
+static void createFileDefinition(llvm::raw_ostream &OS,
+                                 const ClangDocContext &CDCtx,
+                                 const std::optional<Location> &DefLoc) {
+  if (DefLoc)
+    writeFileDefinition(CDCtx, *DefLoc, OS);
+}
+
 static void writeDescription(const CommentInfo &I, raw_ostream &OS) {
   if (I.Kind == "FullComment") {
     for (const auto &Child : I.Children)
@@ -143,8 +151,8 @@ static void genMarkdown(const ClangDocContext &CDCtx, const EnumInfo &I,
     for (const auto &N : I.Members)
       Members << "| " << N.Name << " |\n";
   writeLine(Members.str(), OS);
-  if (I.DefLoc)
-    writeFileDefinition(CDCtx, *I.DefLoc, OS);
+
+  createFileDefinition(OS, CDCtx, I.DefLoc);
 
   for (const auto &C : I.Description)
     writeDescription(C, OS);
@@ -171,8 +179,8 @@ static void genMarkdown(const ClangDocContext &CDCtx, const FunctionInfo &I,
     writeLine(genItalic(I.ReturnType.Type.QualName + " " + I.Name + "(" +
                         Stream.str() + ")"),
               OS);
-  if (I.DefLoc)
-    writeFileDefinition(CDCtx, *I.DefLoc, OS);
+
+  createFileDefinition(OS, CDCtx, I.DefLoc);
 
   for (const auto &C : I.Description)
     writeDescription(C, OS);
@@ -231,8 +239,8 @@ static void genMarkdown(const ClangDocContext &CDCtx, const NamespaceInfo &I,
 static void genMarkdown(const ClangDocContext &CDCtx, const RecordInfo &I,
                         llvm::raw_ostream &OS) {
   writeHeader(getTagType(I.TagType) + " " + I.Name, 1, OS);
-  if (I.DefLoc)
-    writeFileDefinition(CDCtx, *I.DefLoc, OS);
+
+  createFileDefinition(OS, CDCtx, I.DefLoc);
 
   if (!I.Description.empty()) {
     for (const auto &C : I.Description)