tidy public apis

Author: vinniefalco

source/lib/AsciidocGenerator.cpp

@@ -744,7 +744,7 @@ class AsciidocGenerator : public Generator
     llvm::Error
     generateDocs(
         StringRef RootDir,
-        llvm::StringMap<std::unique_ptr<mrdox::Info>> Infos,
+        InfoMap const& Infos,
         ClangDocContext const& CDCtx) override;
 
     llvm::Error
@@ -765,7 +765,7 @@ llvm::Error
 AsciidocGenerator::
 generateDocs(
     StringRef RootDir,
-    llvm::StringMap<std::unique_ptr<mrdox::Info>> Infos,
+    InfoMap const& Infos,
     ClangDocContext const& CDCtx)
 {
     // Track which directories we already tried to create.

source/lib/Generators.h

@@ -24,32 +24,50 @@ namespace mrdox {
 
 struct ClangDocContext;
 
-// Abstract base class for generators.
-// This is expected to be implemented and exposed via the GeneratorRegistry.
-class Generator {
+/** The representation of the source code under analysis.
+*/
+using InfoMap = llvm::StringMap<
+    std::unique_ptr<mrdox::Info>>;
+
+class Generator
+{
 public:
-  virtual ~Generator() = default;
-
-  // Write out the decl info for the objects in the given map in the specified
-  // format.
-  virtual llvm::Error
-  generateDocs(StringRef RootDir,
-               llvm::StringMap<std::unique_ptr<mrdox::Info>> Infos,
-               const ClangDocContext &CDCtx) = 0;
-
-  // This function writes a file with the index previously constructed.
-  // It can be overwritten by any of the inherited generators.
-  // If the override method wants to run this it should call
-  // Generator::createResources(CDCtx);
-  virtual llvm::Error createResources(ClangDocContext &CDCtx);
-
-  // Write out one specific decl info to the destination stream.
-  virtual llvm::Error generateDocForInfo(Info *I, llvm::raw_ostream &OS,
-                                         const ClangDocContext &CDCtx) = 0;
-
-  static void addInfoToIndex(Index &Idx, const mrdox::Info *Info);
+    virtual ~Generator() = default;
+
+    // Write out the decl info for the objects in
+    // the given map in the specified format.
+    virtual
+    llvm::Error
+    generateDocs(
+        StringRef RootDir,
+        InfoMap const& Infos,
+        ClangDocContext const& CDCtx) = 0;
+
+    // This function writes a file with the index previously constructed.
+    // It can be overwritten by any of the inherited generators.
+    // If the override method wants to run this it should call
+    // Generator::createResources(CDCtx);
+    virtual
+    llvm::Error
+    createResources(
+        ClangDocContext& CDCtx);
+
+    // Write out one specific decl info to the destination stream.
+    virtual
+    llvm::Error
+    generateDocForInfo(
+        Info* I, // VFALCO Why not const?
+        llvm::raw_ostream& OS,
+        ClangDocContext const& CDCtx) = 0;
+
+    static
+    void
+    addInfoToIndex(
+        Index& Idx,
+        mrdox::Info const* Info);
 };
 
+// VFALCO a global?
 typedef llvm::Registry<Generator> GeneratorRegistry;
 
 llvm::Expected<std::unique_ptr<Generator>>
@@ -60,4 +78,4 @@ std::string getTagType(TagTypeKind AS);
 } // namespace mrdox
 } // namespace clang
 
-#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
+#endif

source/lib/XMLGenerator.cpp

@@ -113,15 +113,12 @@ class XMLGenerator
 {
 
 public:
-    using InfoMap = llvm::StringMap<
-        std::unique_ptr<mrdox::Info>>;
-
     static char const* Format;
 
     llvm::Error
     generateDocs(
         llvm::StringRef RootDir,
-        InfoMap Infos,
+        InfoMap const& Infos,
         ClangDocContext const& CDCtx) override;
 
     llvm::Error
@@ -177,7 +174,7 @@ llvm::Error
 XMLGenerator::
 generateDocs(
     llvm::StringRef RootDir,
-    InfoMap Infos,
+    InfoMap const& Infos,
     ClangDocContext const& CDCtx)
 {
     llvm::SmallString<256> filename(CDCtx.OutDirectory);

source/mrdox/Main.cpp

@@ -97,18 +97,23 @@ main(int argc, const char** argv)
     //--------------------------------------------
 
     // Ensure the root output directory exists.
-    if (std::error_code Err = llvm::sys::fs::create_directories(CDCtx.OutDirectory);
-        Err != std::error_code()) {
+    if (std::error_code Err =
+            llvm::sys::fs::create_directories(CDCtx.OutDirectory);
+                Err != std::error_code())
+    {
         llvm::errs() << "Failed to create directory '" << CDCtx.OutDirectory << "'\n";
-        return 1;
+        return EXIT_FAILURE;
     }
 
     // Run the generator.
     llvm::outs() << "Generating docs...\n";
-    if (auto Err =
-        CDCtx.G->generateDocs(CDCtx.OutDirectory, std::move(CDCtx.USRToInfo), CDCtx)) {
+    if(auto Err = CDCtx.G->generateDocs(
+        CDCtx.OutDirectory,
+        std::move(CDCtx.USRToInfo),
+        CDCtx))
+    {
         llvm::errs() << toString(std::move(Err)) << "\n";
-        return 1;
+        return EXIT_FAILURE;
     }
 
     //