doxybook::utils

Functions

Member Functions	Description
join	Join string arguments as a path. ^{(function template)}
filename	Get the filename from a path string. ^(function)
escape	Escape a string. ^(function)
title	Capitalize string. ^(function)
to_lower	Convert string to lowercase. ^(function)
safe_anchor_id	Create a safe anchor for a string. ^(function)
namespace_to_package	Convert a namespace string to a package string. ^(function)
date	Get current date as a string. ^(function)
strip_namespace	Strip namespace from symbol. ^(function)
strip_anchor	Strip anchors from a string. ^(function)
split	Split string with the specified delimiter. ^(function)
create_directory	Create a directory. ^(function)
normalize_language	Normalize the language name. ^(function)
replace_newline	Replace newlines with whitespaces. ^(function)

Functions

function join

^{Defined in header <doxybook/utils.hpp>}

template <typename... Args>
std::string
join(Args const &... args);

Join string arguments as a path.

Exception Safety

Basic exception guarantee.

function filename

^{Defined in header <doxybook/utils.hpp>}

std::string
filename(std::string const & path);

Get the filename from a path string.

Exception Safety

Basic exception guarantee.

function escape

^{Defined in header <doxybook/utils.hpp>}

std::string
escape(std::string str);

Escape a string.

Exception Safety

Basic exception guarantee.

function title

^{Defined in header <doxybook/utils.hpp>}

std::string
title(std::string str);

Capitalize string.

Exception Safety

Basic exception guarantee.

function to_lower

^{Defined in header <doxybook/utils.hpp>}

std::string
to_lower(std::string str);

Convert string to lowercase.

Exception Safety

Basic exception guarantee.

function safe_anchor_id

^{Defined in header <doxybook/utils.hpp>}

std::string
safe_anchor_id(std::string str, bool replace_underscores);

Create a safe anchor for a string.

Parameters

replace_underscores - replaces underscores with hyphens
str - string to convert

Return value

converted string

Exception Safety

Basic exception guarantee.

function namespace_to_package

^{Defined in header <doxybook/utils.hpp>}

std::string
namespace_to_package(std::string str);

Convert a namespace string to a package string.

Description

This replaces all occurences of "::" with "."

Exception Safety

Basic exception guarantee.

function date

^{Defined in header <doxybook/utils.hpp>}

std::string
date(std::string const & format);

Get current date as a string.

Exception Safety

Basic exception guarantee.

function strip_namespace

^{Defined in header <doxybook/utils.hpp>}

std::string
strip_namespace(std::string const & format);

Strip namespace from symbol.

Exception Safety

Basic exception guarantee.

function strip_anchor

^{Defined in header <doxybook/utils.hpp>}

std::string
strip_anchor(std::string const & str);

Strip anchors from a string.

Exception Safety

Basic exception guarantee.

function split

^{Defined in header <doxybook/utils.hpp>}

std::vector< std::string >
split(std::string const & str, std::string const & delim);

Split string with the specified delimiter.

Exception Safety

Basic exception guarantee.

function create_directory

^{Defined in header <doxybook/utils.hpp>}

void
create_directory(std::string const & path);

Create a directory.

Exception Safety

Basic exception guarantee.

function normalize_language

^{Defined in header <doxybook/utils.hpp>}

std::string
normalize_language(std::string const & language);

Normalize the language name.

Exception Safety

Basic exception guarantee.

function replace_newline

^{Defined in header <doxybook/utils.hpp>}

std::string
replace_newline(std::string str);

Replace newlines with whitespaces.

Exception Safety

Basic exception guarantee.

_{Updated on 2023-04-03}