feat: adoc template "See also" section

cppalliance · Feb 29, 2024 · 9c20b9d · 9c20b9d
1 parent 1be3e83
commit 9c20b9d
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 5 deletions.
diff --git a/include/mrdocs/Metadata/Javadoc.hpp b/include/mrdocs/Metadata/Javadoc.hpp
@@ -848,6 +848,7 @@ struct Overview
     std::vector<Param const*> params;
     std::vector<TParam const*> tparams;
     std::vector<Throws const*> exceptions;
+    std::vector<See const*> sees;
 };
 
 MRDOCS_DECL dom::String toString(Style style) noexcept;

diff --git a/share/mrdocs/addons/generator/asciidoc/partials/symbols/record.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/symbols/record.adoc.hbs
@@ -25,4 +25,12 @@
 
 {{/if}}
 
-{{! TODO: == See Also }}
+{{#if symbol.doc.see}}
+== See Also
+
+{{#each symbol.doc.see}}
+{{.}}
+
+{{/each}}
+
+{{/if}}
diff --git a/src/lib/Gen/adoc/AdocCorpus.cpp b/src/lib/Gen/adoc/AdocCorpus.cpp
@@ -378,6 +378,18 @@ domCreate(
     return dom::Object(std::move(entries));
 }
 
+static
+dom::Value
+domCreate(
+    const doc::See& I,
+    const AdocCorpus& corpus)
+{
+    std::string s;
+    DocVisitor visitor(corpus, s);
+    visitor(static_cast<const doc::See&>(I));
+    return s;
+}
+
 //------------------------------------------------
 
 class DomJavadoc : public dom::LazyObjectImpl
@@ -464,6 +476,7 @@ class DomJavadoc : public dom::LazyObjectImpl
         maybeEmplaceArray(list, "params", ov.params);
         maybeEmplaceArray(list, "tparams", ov.tparams);
         maybeEmplaceArray(list, "exceptions", ov.exceptions);
+        maybeEmplaceArray(list, "see", ov.sees);
 
         return dom::Object(std::move(list));
     }

diff --git a/src/lib/Gen/adoc/Options.cpp b/src/lib/Gen/adoc/Options.cpp
@@ -132,8 +132,11 @@ loadOptions(
     }
     else
     {
-        // VFALCO TODO get process executable
-        // and form a path relative to that.
+        opt.template_dir = files::makeDirsy(files::appendPath(
+            corpus.config->addonsDir,
+            "generator",
+            "asciidoc"
+        ));
     }
 
     if(! opt.template_dir.empty())
@@ -145,8 +148,11 @@ loadOptions(
     }
     else
     {
-        // VFALCO TODO get process executable
-        // and form a path relative to that.
+        opt.template_dir = files::makeDirsy(files::appendPath(
+            corpus.config->addonsDir,
+            "generator",
+            "asciidoc"
+        ));
     }
 
     return opt;

diff --git a/src/lib/Metadata/Javadoc.cpp b/src/lib/Metadata/Javadoc.cpp
@@ -274,6 +274,10 @@ makeOverview(
             ov.exceptions.push_back(static_cast<
                 doc::Throws const*>(it->get()));
             break;
+        case doc::Kind::see:
+            ov.sees.push_back(static_cast<
+                doc::See const*>(it->get()));
+            break;
         default:
             if(ov.brief == it->get())
                 break;