generator.h Header
Types
| class | HtmlBuilder | |
| struct | ClassAnchors | The element ids of a type page's documented declarations, in the order the page renders them. Overloads and other repeats get "-2", "-3", ... suffixes (the first keeps the bare name so older links still land). Shared by the generator and the engine's LinkMap so links always match the page. |
| struct | HeaderAnchors | The element ids of a header page's declarations. Functions first (so the first overload keeps the bare name), then aliases, then enums. |
| struct | ApiIndexEntry | One entry of api.json, the docs sidebar's index |
| struct | HeaderPageContext | Everything a header page needs beyond the HeaderInfo itself. |
| struct | ClassPageContext | Everything a type page needs beyond the ClassInfo itself. |
| class | Generator |
Type Aliases
| using | LinkMap | Documented name -> page-relative href, for linking names wherever they appear in rendered type spellings. Keys are spelled as in code: top-level types unqualified ("LName"), nested declarations qualified by their owner ("LUnresolvedLink::Reason"). Values look like "lname.html" or "lunresolvedlink.html#Reason". |
Functions
| std::string | qualified_name(const ClassInfo & class_info) |
| std::string | type_page_name(const ClassInfo & class_info) |
| std::string | link_types(const std::string & spelling, const LinkMap & links) |
| std::string | clean_comment(const std::string & raw_comment) |
| ClassAnchors | class_anchors(const ClassInfo & class_info) |
| HeaderAnchors | header_anchors(const HeaderInfo & header) |
| std::string | comment_brief(const std::string & raw_comment) |
Type Alias Documentation
using LinkMap = std::map<std::string, std::string>
Documented name -> page-relative href, for linking names wherever they appear in rendered type spellings. Keys are spelled as in code: top-level types unqualified ("LName"), nested declarations qualified by their owner ("LUnresolvedLink::Reason"). Values look like "lname.html" or "lunresolvedlink.html#Reason".
Function Documentation
std::string qualified_name(const ClassInfo & class_info)
The owner-qualified name of a type: "Outer::Inner" for nested types.
std::string type_page_name(const ClassInfo & class_info)
A type's page filename: the lowercased qualified name with "::" as "-" ("lname.html", "outer-inner.html").
std::string link_types(const std::string & spelling, const LinkMap & links)
HTML for a type spelling with every documented name linked (see LinkMap). Qualified names match their longest documented suffix ("Layers::LObject" links LObject); std:: names never link. Everything else is HTML-escaped.
std::string clean_comment(const std::string & raw_comment)
A raw doc comment as Markdown: comment markers ( , leading *, and for runs of line comments //, ///, //!) removed and the common indentation stripped, so relative indentation (code blocks) survives.
ClassAnchors class_anchors(const ClassInfo & class_info)
No description available.
HeaderAnchors header_anchors(const HeaderInfo & header)
No description available.
std::string comment_brief(const std::string & raw_comment)
A comment's first paragraph as inline HTML for summary tables: escaped,
lines joined, code spans kept as , text reduced to text.
Empty when the comment is.