Developer

Doxide's own source code documentation, for developers, but also serving as an example for others.

Types

Name	Description
Driver	Driver for running commands
Entity	Entity in a C++ source file, e.g. variable, function, class, etc.
EntityType	Entity types.
GcovGenerator	Gcov JSON generator.
MarkdownGenerator	Markdown generator.
Parser	C++ source parser.
Token	Token.
TokenType	Documentation comment token types.
Tokenizer	Documentation comment tokenizer.
YAMLNode	Node in a YAML document.
YAMLParser	Parser for YAML config files and YAML frontmatter of Markdown files.

Macros

Name	Description
error	Print an error message and exit.
warn	Print a warning message.

Variables

Name	Description
init_docs_javascripts_mathjax_js	Contents of initial docs/javascripts/mathjax.js file.
init_docs_overrides_partials_copyright_html	Contents of initial docs/overrides/partials/copyright.html file.
init_docs_stylesheets_doxide_css	Contents of initial docs/stylesheets/doxide.css file.
init_doxide_yaml	Contents of initial doxide.yaml file.
init_mkdocs_yaml	Contents of initial mkdocs.yaml file.
query_cpp	Query for entities in C++ sources.
regexes	Documentation comment token patterns.

Functions

Name	Description
copy_file_prompt	Copy a file, prompting to confirm overwrite if the destination already exists.
gulp	Read in a whole file.
tree_sitter_cpp	Tree-sitter C++ language handle.
tree_sitter_cuda	Tree-sitter CUDA language handle.
write_file	Write a whole file.
write_file_prompt	Write a whole file, prompting to confirm overwrite if it already exists.

Macro Details

error

#define error(msg)

Print an error message and exit.

warn

#define warn(msg)

Print a warning message.

Variable Details

init_docs_javascripts_mathjax_js

extern const char* init_docs_javascripts_mathjax_js

Contents of initial docs/javascripts/mathjax.js file.

init_docs_overrides_partials_copyright_html

extern const char* init_docs_overrides_partials_copyright_html

Contents of initial docs/overrides/partials/copyright.html file.

init_docs_stylesheets_doxide_css

extern const char* init_docs_stylesheets_doxide_css

Contents of initial docs/stylesheets/doxide.css file.

init_doxide_yaml

extern const char* init_doxide_yaml

Contents of initial doxide.yaml file.

init_mkdocs_yaml

extern const char* init_mkdocs_yaml

Contents of initial mkdocs.yaml file.

query_cpp

extern const char* query_cpp

Query for entities in C++ sources.

regexes

static auto regexes

Documentation comment token patterns. Order is important, as a match to an earlier pattern precludes a match to a later.

Function Details

copy_file_prompt

void copy_file_prompt(const std::filesystem::path& src, const std::filesystem::path& dst)

Copy a file, prompting to confirm overwrite if the destination already exists.

gulp

std::string gulp(const std::filesystem::path& src)

Read in a whole file.

tree_sitter_cpp

const TSLanguage* tree_sitter_cpp()

Tree-sitter C++ language handle.

tree_sitter_cuda

const TSLanguage* tree_sitter_cuda()

Tree-sitter CUDA language handle.

write_file

void write_file(const std::string& contents, const std::filesystem::path& dst)

Write a whole file.

write_file_prompt

void write_file_prompt(const std::string& contents, const std::filesystem::path& dst)

Write a whole file, prompting to confirm overwrite if it already exists.