[clang-doc][refactor] improve naming of writeFileDefinition

Author: hulxv

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

@@ -491,7 +491,7 @@ genReferencesBlock(const std::vector<Reference> &References,
   return Out;
 }
 static std::unique_ptr<TagNode>
-writeFileDefinition(const ClangDocContext &CDCtx, const Location &L) {
+writeSourceFileRef(const ClangDocContext &CDCtx, const Location &L) {
 
   if (!L.IsFileInRootDir && !CDCtx.RepositoryUrl)
     return std::make_unique<TagNode>(
@@ -528,11 +528,11 @@ writeFileDefinition(const ClangDocContext &CDCtx, const Location &L) {
   return Node;
 }
 
-static void createFileDefinition(std::vector<std::unique_ptr<TagNode>> &Out,
+static void maybeWriteSourceFileRef(std::vector<std::unique_ptr<TagNode>> &Out,
                                  const ClangDocContext &CDCtx,
                                  const std::optional<Location> &DefLoc) {
   if (DefLoc)
-    Out.emplace_back(writeFileDefinition(CDCtx, *DefLoc));
+    Out.emplace_back(writeSourceFileRef(CDCtx, *DefLoc));
 }
 
 static std::vector<std::unique_ptr<TagNode>>
@@ -754,7 +754,7 @@ genHTML(const EnumInfo &I, const ClangDocContext &CDCtx) {
 
   Out.emplace_back(std::move(Table));
 
-  createFileDefinition(Out, CDCtx, I.DefLoc);
+  maybeWriteSourceFileRef(Out, CDCtx, I.DefLoc);
 
   std::string Description;
   if (!I.Description.empty())
@@ -797,7 +797,7 @@ genHTML(const FunctionInfo &I, const ClangDocContext &CDCtx,
   }
   FunctionHeader->Children.emplace_back(std::make_unique<TextNode>(")"));
 
-  createFileDefinition(Out, CDCtx, I.DefLoc);
+  maybeWriteSourceFileRef(Out, CDCtx, I.DefLoc);
 
   std::string Description;
   if (!I.Description.empty())
@@ -858,7 +858,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));
 
-  createFileDefinition(Out, CDCtx, I.DefLoc);
+  maybeWriteSourceFileRef(Out, CDCtx, I.DefLoc);
 
   std::string Description;
   if (!I.Description.empty())

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

@@ -52,7 +52,7 @@ static void writeHeader(const Twine &Text, unsigned int Num, raw_ostream &OS) {
   OS << std::string(Num, '#') + " " + Text << "\n\n";
 }
 
-static void writeFileDefinition(const ClangDocContext &CDCtx, const Location &L,
+static void writeSourceFileRef(const ClangDocContext &CDCtx, const Location &L,
                                 raw_ostream &OS) {
 
   if (!CDCtx.RepositoryUrl) {
@@ -67,11 +67,11 @@ static void writeFileDefinition(const ClangDocContext &CDCtx, const Location &L,
   OS << "\n\n";
 }
 
-static void createFileDefinition(llvm::raw_ostream &OS,
+static void maybeWriteSourceFileRef(llvm::raw_ostream &OS,
                                  const ClangDocContext &CDCtx,
                                  const std::optional<Location> &DefLoc) {
   if (DefLoc)
-    writeFileDefinition(CDCtx, *DefLoc, OS);
+    writeSourceFileRef(CDCtx, *DefLoc, OS);
 }
 
 static void writeDescription(const CommentInfo &I, raw_ostream &OS) {
@@ -151,7 +151,7 @@ static void genMarkdown(const ClangDocContext &CDCtx, const EnumInfo &I,
       Members << "| " << N.Name << " |\n";
   writeLine(Members.str(), OS);
 
-  createFileDefinition(OS, CDCtx, I.DefLoc);
+  maybeWriteSourceFileRef(OS, CDCtx, I.DefLoc);
 
   for (const auto &C : I.Description)
     writeDescription(C, OS);
@@ -179,7 +179,7 @@ static void genMarkdown(const ClangDocContext &CDCtx, const FunctionInfo &I,
                         Stream.str() + ")"),
               OS);
 
-  createFileDefinition(OS, CDCtx, I.DefLoc);
+  maybeWriteSourceFileRef(OS, CDCtx, I.DefLoc);
 
   for (const auto &C : I.Description)
     writeDescription(C, OS);
@@ -239,7 +239,7 @@ static void genMarkdown(const ClangDocContext &CDCtx, const RecordInfo &I,
                         llvm::raw_ostream &OS) {
   writeHeader(getTagType(I.TagType) + " " + I.Name, 1, OS);
 
-  createFileDefinition(OS, CDCtx, I.DefLoc);
+  maybeWriteSourceFileRef(OS, CDCtx, I.DefLoc);
 
   if (!I.Description.empty()) {
     for (const auto &C : I.Description)