Developer

Doxide’s own source code documentation.

Types

Name Description
CppParser C++ source parser.
Doc Documentation of an entity.
DocToken Token.
DocTokenType Documentation comment token types.
DocTokenizer Documentation comment tokenizer.
Driver Driver for running commands
Entity Entity in a C++ source file, e.g. variable, function, class, etc.
EntityType Entity types.
GcovCounter Gcov processor for coverage data.
JSONCounter JSON processor for coverage data following gcov/gcovr schema.
JSONGenerator JSON generator for coverage data following gcov/gcovr schema.
MarkdownGenerator Markdown generator.
SourceWatcher Source Watcher.
TextLineCursor Allows cursoring through external text keeping track of the line number.
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
REGEX_FLAGS Regular expression configuration.
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.
query_cpp_exclude Query for entities to explicitly exclude from line counts in C++ sources.
query_cpp_include Query for entities to explicitly include in line counts in C++ sources.
regexes Documentation comment token patterns.

Operators

Name Description
operator<< Allows printing the cursor v into the stream s.
operator== Compares the text in the view v against that in the cursor w.

Functions

Name Description
capitalize Convert a string to lowercase with uppercase first character.
gulp Read in a whole file.
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

REGEX_FLAGS

constexpr std::regex_constants::syntax_option_type REGEX_FLAGS

Regular expression configuration.

static const char* init_docs_overrides_partials_copyright_html

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

init_docs_stylesheets_doxide_css

static const char* init_docs_stylesheets_doxide_css

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

init_doxide_yaml

static const char* init_doxide_yaml

Contents of initial doxide.yaml file.

init_mkdocs_yaml

static const char* init_mkdocs_yaml

Contents of initial mkdocs.yaml file.

query_cpp

static const char* query_cpp

Query for entities in C++ sources.

query_cpp_exclude

static const char* query_cpp_exclude

Query for entities to explicitly exclude from line counts in C++ sources.

query_cpp_include

static const char* query_cpp_include

Query for entities to explicitly include in line counts 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.

Operator Details

operator<<

inline std::ostream& operator<<(std::ostream& s, const TextLineCursor& v)

Allows printing the cursor v into the stream s.

operator==

inline bool operator==(const std::string_view& v, const TextLineCursor& w)

Compares the text in the view v against that in the cursor w.

Function Details

capitalize

std::string capitalize(const std::string_view s)

Convert a string to lowercase with uppercase first character.

gulp

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

Read in a whole file.

tree_sitter_cuda

const TSLanguage* tree_sitter_cuda()

Tree-sitter CUDA language handle.

write_file

static 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.