Fix generator bugs

.github/workflows/ci.yml

@@ -625,6 +625,7 @@ jobs:
           declare -a generators=(
             "adoc"
             "xml"
+            "html"
           )
 
           # Generate the demos for each variant and generator

docs/mrdocs.schema.json

@@ -50,6 +50,11 @@
       "title": "Detect SFINAE expressions",
       "type": "boolean"
     },
+    "embedded": {
+      "default": false,
+      "title": "Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document. This option is useful for producing documents that can be inserted into an external template.",
+      "type": "boolean"
+    },
     "filters": {
       "properties": {
         "symbols": {
@@ -168,6 +173,12 @@
       "title": "Include files to extract",
       "type": "object"
     },
+    "legible-names": {
+      "default": true,
+      "description": "Use legible names for ids in the documentation. When set to true, MrDocs uses legible names for symbols in the documentation. These are symbols that are legible but still safe for URLs. When the option is set to false, MrDocs uses a hash of the symbol ID.",
+      "title": "Use legible names",
+      "type": "boolean"
+    },
     "multipage": {
       "default": true,
       "description": "Generates a multipage documentation. The output directory must be a directory. This option acts as a hint to the generator to create a multipage documentation. Whether the hint is followed or not depends on the generator.",

include/mrdocs/Generator.hpp

@@ -99,8 +99,6 @@ class MRDOCS_VISIBLE
         @param corpus The symbols to emit. The
         generator may modify the contents of
         the object before returning.
-
-        @param config The configuration to use.
     */
     MRDOCS_DECL
     virtual
@@ -109,6 +107,22 @@ class MRDOCS_VISIBLE
         std::string_view outputPath,
         Corpus const& corpus) const;
 
+    /** Build reference documentation for the corpus.
+
+        This function invokes the generator to emit
+        the documentation using the corpus configuration
+        options to determine the output location.
+
+        @return The error, if any occurred.
+
+        @param corpus The symbols to emit. The
+        generator may modify the contents of
+        the object before returning.
+    */
+    MRDOCS_DECL
+    Error
+    build(Corpus const& corpus) const;
+
     /** Build reference documentation for the corpus.
 
         This function invokes the generator to emit

include/mrdocs/Support/Error.hpp

@@ -606,6 +606,14 @@ namespace detail
 #    define MRDOCS_CHECK_GET_MACRO(_1, _2, NAME, ...) NAME
 #    define MRDOCS_CHECK(...) \
         MRDOCS_CHECK_GET_MACRO(__VA_ARGS__, MRDOCS_CHECK_MSG, MRDOCS_CHECK_VOID)(__VA_ARGS__)
+
+#    define MRDOCS_CHECK_OR(var, expr)                         \
+        if (detail::failed(var)) {                        \
+            return expr;         \
+        }                                                  \
+        void(0)
+
+
 #endif
 
 

include/mrdocs/Support/Handlebars.hpp

@@ -268,7 +268,9 @@ class MRDOCS_DECL OutputRef
         @param os The output stream to write to
      */
     template <detail::LHROStreamable Os>
-    requires std::is_convertible_v<Os*, std::ostream*>
+    requires
+        std::is_convertible_v<Os*, std::ostream*> &&
+        (!detail::StdLHROStreamable<Os>)
     OutputRef( Os& os )
         : out_( &os )
         , fptr_( &write_to_output<Os> )

share/mrdocs/addons/generator/adoc/layouts/overload-set.adoc.hbs → share/mrdocs/addons/generator/adoc/layouts/index-overload-set.adoc.hbs

@@ -2,7 +2,7 @@
 {{#if relfileprefix}}:relfileprefix: {{relfileprefix}}{{/if}}
 [#{{sectionref}}]
 
-={{#unless is_multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else}}Unnamed overload set{{/if}}
+={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else}}Unnamed overload set{{/if}}
 
 {{#if symbol.members.[0]}}
 
@@ -12,7 +12,7 @@
 
 {{/if}}
 
-=={{#unless is_multipage}}={{/unless}} Synopsis
+=={{#unless @root.config.multipage}}={{/unless}} Synopsis
 
 {{#each symbol.members as | member |}}
 
@@ -23,14 +23,14 @@
 {{/each}}
 
 {{#if symbol.members.[0].doc.description}}
-=={{#unless is_multipage}}={{/unless}} Description
+=={{#unless @root.config.multipage}}={{/unless}} Description
 
 {{symbol.members.[0].doc.description}}
 {{/if}}
 
 {{#with (flattenUnique symbol.members "doc.exceptions" "exception") as |allExceptions|}}
 {{#if (ne (len allExceptions) 0)}}
-=={{#unless is_multipage}}={{/unless}} Exceptions
+=={{#unless @root.config.multipage}}={{/unless}} Exceptions
 
 |===
 | Name | Thrown on
@@ -44,15 +44,15 @@
 {{/with}}
 
 {{#if symbol.members.[0].doc.returns}}
-=={{#unless is_multipage}}={{/unless}} Return Value
+=={{#unless @root.config.multipage}}={{/unless}} Return Value
 
 {{symbol.members.[0].doc.returns}}
 
 {{/if}}
 
 {{#with (flattenUnique symbol.members "doc.params" "name") as |allParams|}}
 {{#if (ne (len allParams) 0)}}
-=={{#unless is_multipage}}={{/unless}} Parameters
+=={{#unless @root.config.multipage}}={{/unless}} Parameters
 
 |===
 | Name | Description {{! TODO: | Type? }}
@@ -66,7 +66,7 @@
 {{/with}}
 
 {{#if symbol.members.[0].doc.preconditions}}
-=={{#unless is_multipage}}={{/unless}} Preconditions
+=={{#unless @root.config.multipage}}={{/unless}} Preconditions
 
 {{#each symbol.members.[0].doc.preconditions}}
 {{.}}
@@ -75,7 +75,7 @@
 {{/if}}
 
 {{#if symbol.members.[0].doc.postconditions}}
-=={{#unless is_multipage}}={{/unless}} Postconditions
+=={{#unless @root.config.multipage}}={{/unless}} Postconditions
 
 {{#each symbol.members.[0].doc.postconditions}}
 {{.}}
@@ -84,7 +84,7 @@
 {{/if}}
 
 {{#if symbol.members.[0].doc.see}}
-=={{#unless is_multipage}}={{/unless}} See Also
+=={{#unless @root.config.multipage}}={{/unless}} See Also
 
 {{#each symbol.members.[0].doc.see}}
 {{.}}

share/mrdocs/addons/generator/adoc/layouts/single-symbol.adoc.hbs → share/mrdocs/addons/generator/adoc/layouts/index.adoc.hbs

@@ -1,5 +1,5 @@
 {{! The section with a symbol in single page output or the symbol page in multi page output }}
 {{#if relfileprefix}}:relfileprefix: {{relfileprefix}}{{/if}}
-[#{{sectionref}}]
 
+[#{{sectionref}}]
 {{> (concat 'symbols' '/' (lookup symbol 'kind')) symbol=symbol}}

share/mrdocs/addons/generator/adoc/layouts/wrapper.adoc.hbs

@@ -0,0 +1,9 @@
+{{! The wrapper for single page documentation or symbols in a multipage documentation }}
+{{#unless @root.config.multipage }}
+= Reference
+:mrdocs:
+{{/unless}}
+{{! Content generated with index.hbs }}
+{{contents}}
+
+[.small]#Created with https://www.mrdocs.com[MrDocs]#

share/mrdocs/addons/generator/adoc/partials/symbols/alias.adoc.hbs

@@ -1,9 +1,9 @@
 {{!-- alias --}}
-={{#unless is_multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
+={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{symbol.doc.brief}}
 
-=={{#unless is_multipage}}={{/unless}} Synopsis
+=={{#unless @root.config.multipage}}={{/unless}} Synopsis
 
 {{>types/source dcl=(primary_location symbol)}}
 
@@ -13,14 +13,14 @@
 ----
 
 {{#if symbol.doc.description}}
-=={{#unless is_multipage}}={{/unless}} Description
+=={{#unless @root.config.multipage}}={{/unless}} Description
 
 {{symbol.doc.description}}
 
 {{/if}}
 
 {{#if symbol.doc.see}}
-=={{#unless is_multipage}}={{/unless}} See Also
+=={{#unless @root.config.multipage}}={{/unless}} See Also
 
 {{#each symbol.doc.see}}
 {{.}}

share/mrdocs/addons/generator/adoc/partials/symbols/enum.adoc.hbs

@@ -1,9 +1,9 @@
 {{!-- enum --}}
-={{#unless is_multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else}}Unnamed enum{{/if}}
+={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else}}Unnamed enum{{/if}}
 
 {{symbol.doc.brief}}
 
-=={{#unless is_multipage}}={{/unless}} Synopsis
+=={{#unless @root.config.multipage}}={{/unless}} Synopsis
 
 {{>types/source dcl=(primary_location symbol)}}
 
@@ -13,7 +13,7 @@
 ----
 
 {{#if symbol.members}}
-=={{#unless is_multipage}}={{/unless}} Members
+=={{#unless @root.config.multipage}}={{/unless}} Members
 [,cols=2]
 |===
 |Name |Description
@@ -24,13 +24,13 @@
 {{/if}}
 
 {{#if symbol.doc.description}}
-=={{#unless is_multipage}}={{/unless}} Description
+=={{#unless @root.config.multipage}}={{/unless}} Description
 
 {{symbol.doc.description}}
 {{/if}}
 
 {{#if symbol.doc.see}}
-=={{#unless is_multipage}}={{/unless}} See Also
+=={{#unless @root.config.multipage}}={{/unless}} See Also
 
 {{#each symbol.doc.see}}
 {{.}}

share/mrdocs/addons/generator/adoc/partials/symbols/enumerator.adoc.hbs

@@ -1,9 +1,9 @@
 {{!-- enumerator --}}
-={{#unless is_multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
+={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{symbol.doc.brief}}
 
-=={{#unless is_multipage}}={{/unless}} Synopsis
+=={{#unless @root.config.multipage}}={{/unless}} Synopsis
 
 {{>types/source dcl=(primary_location symbol)}}
 
@@ -14,14 +14,14 @@
 ----
 
 {{#if symbol.doc.description}}
-=={{#unless is_multipage}}={{/unless}} Description
+=={{#unless @root.config.multipage}}={{/unless}} Description
 
 {{symbol.doc.description}}
 
 {{/if}}
 
 {{#if symbol.doc.see}}
-=={{#unless is_multipage}}={{/unless}} See Also
+=={{#unless @root.config.multipage}}={{/unless}} See Also
 
 {{#each symbol.doc.see}}
 {{.}}

share/mrdocs/addons/generator/adoc/partials/symbols/field.adoc.hbs

@@ -1,9 +1,9 @@
 {{!-- field --}}
-={{#unless is_multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
+={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{symbol.doc.brief}}
 
-=={{#unless is_multipage}}={{/unless}} Synopsis
+=={{#unless @root.config.multipage}}={{/unless}} Synopsis
 
 {{>types/source dcl=(primary_location symbol)}}
 
@@ -13,14 +13,14 @@
 ----
 
 {{#if symbol.doc.description}}
-=={{#unless is_multipage}}={{/unless}} Description
+=={{#unless @root.config.multipage}}={{/unless}} Description
 
 {{symbol.doc.description}}
 
 {{/if}}
 
 {{#if symbol.doc.see}}
-=={{#unless is_multipage}}={{/unless}} See Also
+=={{#unless @root.config.multipage}}={{/unless}} See Also
 
 {{#each symbol.doc.see}}
 {{.}}

share/mrdocs/addons/generator/adoc/partials/symbols/friend.adoc.hbs

@@ -1,9 +1,9 @@
 {{!-- friend --}}
-={{#unless is_multipage}}={{/unless}} {{#if symbol.symbol}}{{>types/nested-name-specifier symbol=symbol.symbol.parent includeNamespace=true}}{{symbol.symbol.name}}{{else}}{{symbol.type.name}}{{/if}}
+={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.symbol}}{{>types/nested-name-specifier symbol=symbol.symbol.parent includeNamespace=true}}{{symbol.symbol.name}}{{else}}{{symbol.type.name}}{{/if}}
 
 {{symbol.doc.brief}}
 
-=={{#unless is_multipage}}={{/unless}} Synopsis
+=={{#unless @root.config.multipage}}={{/unless}} Synopsis
 
 {{>types/source dcl=(primary_location symbol)}}
 
@@ -13,14 +13,14 @@
 ----
 
 {{#if symbol.doc.description}}
-=={{#unless is_multipage}}={{/unless}} Description
+=={{#unless @root.config.multipage}}={{/unless}} Description
 
 {{symbol.doc.description}}
 
 {{/if}}
 
 {{#if symbol.doc.see}}
-=={{#unless is_multipage}}={{/unless}} See Also
+=={{#unless @root.config.multipage}}={{/unless}} See Also
 
 {{#each symbol.doc.see}}
 {{.}}