Generator Class

#include <generator.h>

Public Functions

	Generator(Logger * logger = nullptr)
bool	generate_class_file(const std::string & filename, const ClassInfo & class_info, const Configuration & config, const ClassPageContext & context = {})
bool	generate_header_file(const std::string & filename, const HeaderInfo & header, const Configuration & config, const HeaderPageContext & context)
bool	generate_api_json(const std::string & output_dir, const std::vector<ApiIndexEntry> & entries)
bool	generate_topic_file(const std::string & filename, const TopicInfo & topic, const Configuration & config)
bool	generate_topics_json(const std::string & output_dir, const std::vector<TopicInfo> & topics)
bool	generate_license_file(const std::string & filename, const Configuration & config)

Detailed Description

No description available.

Member Function Documentation

Generator(Logger * logger = nullptr)

No description available.

bool generate_class_file(const std::string & filename, const ClassInfo & class_info, const Configuration & config, const ClassPageContext & context = {})

No description available.

bool generate_header_file(const std::string & filename, const HeaderInfo & header, const Configuration & config, const HeaderPageContext & context)

A header page: summary tables for the header's types, aliases, enums and functions, then full documentation for everything but the types (which have their own pages).

bool generate_api_json(const std::string & output_dir, const std::vector<ApiIndexEntry> & entries)

Emit api.json: the ordered [{name, kind, href, parent?}] index the site builds the Classes/Structs/Headers sidebar lists from.

bool generate_topic_file(const std::string & filename, const TopicInfo & topic, const Configuration & config)

Emit a topic page: a fixed doc-page template wrapping {{ render_markdown(markdown) }} (the SiteEngine renders the sibling .md to HTML at site-build), with the topic's title and optional intro baked in. The Markdown itself is copied separately by the Engine, not written here.

bool generate_topics_json(const std::string & output_dir, const std::vector<TopicInfo> & topics)

Emit the topics manifest (topics.json) — an ordered [{label, href}] list the SiteEngine reads to build the docs sidebar's Topics section, mirroring how api.json drives the Classes/Structs/Headers sections.

bool generate_license_file(const std::string & filename, const Configuration & config)

Emit license.html: the "licensed under" line is baked from the version's license_display (omitted when empty); the body ({{ render_markdown(version.license_md) }}) is rendered by the SiteEngine at site-build from the LICENSE.md bundled beside this page.