chore: tidy up config settings

Author: vinniefalco

docs/modules/ROOT/nav.adoc

@@ -1,6 +1,7 @@
 * xref:index.adoc[]
 * xref:install.adoc[]
 * xref:usage.adoc[]
+* xref:config-file.adoc[]
 * xref:commands.adoc[]
 * xref:design-notes.adoc[]
 * xref:contribute.adoc[]

docs/modules/ROOT/pages/config-file.adoc

@@ -0,0 +1,64 @@
+= The Configuration File
+
+[,yaml]
+----
+concurrency: # <.>
+defines: # <.>
+ignore-failures: # <.>
+include-anonymous: # <.>
+include-private: # <.>
+input:
+  include: # <.>
+multipage: # <.>
+source-root: # <.>
+----
+<.> Optional `concurrency` key
+<.> Optional `defines` key
+<.> Optional `ignore-failures` key
+<.> Optional `include-anonymous` key
+<.> Optional `include-private` key
+<.> Optional `include` key
+<.> Optional `multipage` key
+<.> Optional `source-root` key
+
+== Available configuration keys
+
+[cols="3,6,1"]
+|===
+|Keys |Description |Required
+
+|concurrency
+|The amount of parallelism desired. 0 to use
+the hardware-suggested concurrency.
+|No
+
+|defines
+|Additional preprocessor directives in the form "NAME=VALUE".
+|No
+
+|ignore-failures
+|Whether to ignore failures during symbol extraction. `true` or `false`.
+|No
+
+|include-anonymous
+|Whether to extract symbols from anonymous namespaces. `true` or `false`.
+|No
+
+|include-private
+|Whether to extract private members. `true` or `false`.
+|No
+
+|include
+|The amount of parallelism desired. 0 to use
+the hardware-suggested concurrency.
+|No
+
+|multipage
+|Whether to emit the reference as a set of files or just one file. `true` or `false`.
+|No
+
+|source-root
+|The absolute or relative path to the directory containing the
+input file hierarchy.
+|No
+|===

include/mrdox/Config.hpp

@@ -44,17 +44,20 @@ class MRDOX_DECL
 public:
     struct Settings
     {
-        /** `true` if AST visitation failures should not stop the program.
+        /** The level of concurrency desired.
 
-            @code
-            ignore-failures: true
-            @endcode
+            This will always be greater than zero.
         */
-        bool ignoreFailures = false;
+        unsigned int concurrency = 0;
 
-        /** `true` if output should consist of multiple files.
+        /** `true` if anonymous namespace members should be extracted and displayed.
+
+            In some cases anonymous namespace members will
+            be listed even if this configuration value is set to
+            `false`. For example, this may occur for a class derived
+            from one declared within an anonymous namespace.
         */
-        bool multiPage = false;
+        bool includeAnonymous = true;
 
         /** `true` if private members should be extracted and displayed.
 
@@ -65,20 +68,9 @@ class MRDOX_DECL
         */
         bool includePrivate = false;
 
-        /** `true` if anonymous namespace members should be extracted and displayed.
-
-            In some cases anonymous namespace members will
-            be listed even if this configuration value is set to
-            `false`. For example, this may occur for a class derived
-            from one declared within an anonymous namespace.
-        */
-        bool includeAnonymous = true;
-
-        /** The level of concurrency desired.
-
-            This will always be greater than zero.
+        /** `true` if output should consist of multiple files.
         */
-        unsigned int concurrency = 0;
+        bool multiPage = false;
 
         //--------------------------------------------
 

lib/Lib/AbsoluteCompilationDatabase.cpp

@@ -201,7 +201,7 @@ AbsoluteCompilationDatabase(
         cmd.Output = cmd0.Output;
         cmd.CommandLine = adjustCommandLine(
             cmd0.CommandLine,
-            (*config_impl)->additionalDefines);
+            (*config_impl)->defines);
 
         if(path::is_absolute(cmd0.Directory))
         {

lib/Lib/ConfigImpl.cpp

@@ -46,13 +46,12 @@ struct llvm::yaml::MappingTraits<
     static void mapping(IO& io,
         clang::mrdox::ConfigImpl::SettingsImpl& cfg)
     {
+        io.mapOptional("concurrency",       cfg.concurrency);
+        io.mapOptional("defines",           cfg.defines);
         io.mapOptional("ignore-failures",   cfg.ignoreFailures);
+        io.mapOptional("include-anonymous", cfg.includeAnonymous);
+        io.mapOptional("include-private",   cfg.includePrivate);
         io.mapOptional("multipage",         cfg.multiPage);
-        io.mapOptional("with-private",      cfg.includePrivate);
-        io.mapOptional("with-anonymous",    cfg.includeAnonymous);
-        io.mapOptional("concurrency",       cfg.concurrency);
-
-        io.mapOptional("defines",           cfg.additionalDefines);
         io.mapOptional("source-root",       cfg.sourceRoot);
 
         io.mapOptional("input",             cfg.input);

lib/Lib/ConfigImpl.hpp

@@ -35,7 +35,17 @@ class ConfigImpl
             std::vector<std::string> include;
         };
 
-        std::vector<std::string> additionalDefines;
+        /** Additional defines passed to the compiler.
+        */
+        std::vector<std::string> defines;
+
+        /** `true` if AST visitation failures should not stop the program.
+
+            @code
+            ignore-failures: true
+            @endcode
+        */
+        bool ignoreFailures = false;
 
         /** The full path to the source root directory.
 

lib/Lib/CorpusImpl.cpp

@@ -99,9 +99,8 @@ mrdox::Expected<std::unique_ptr<Corpus>>
 CorpusImpl::
 build(
     ToolExecutor& ex,
-    std::shared_ptr<Config const> config_)
+    std::shared_ptr<ConfigImpl const> config)
 {
-    auto config = std::dynamic_pointer_cast<ConfigImpl const>(config_);
     auto corpus = std::make_unique<CorpusImpl>(config);
 
     // Traverse the AST for all translation units
@@ -112,7 +111,7 @@ build(
         makeFrontendActionFactory(
             *ex.getExecutionContext(), *config))))
     {
-        if(! corpus->config->ignoreFailures)
+        if(! (*config)->ignoreFailures)
             return err;
         report::warn(
             "Warning: mapping failed because ", err);

lib/Lib/CorpusImpl.hpp

@@ -55,7 +55,7 @@ class CorpusImpl : public Corpus
     mrdox::Expected<std::unique_ptr<Corpus>>
     build(
         ToolExecutor& ex,
-        std::shared_ptr<Config const> config);
+        std::shared_ptr<ConfigImpl const> config);
 
 private:
     std::vector<Info const*> const&