ug::DocuGen::Doxygen Namespace Reference

Organization unit for Doxygen commands. More...

Variables
static const string	ADDTOGROUP = "/// \\addtogroup "
static const string	BRIEF = "/// \\brief "
static const string	CLASS = "/// \\class "
static const string	DEFGROUP = "/// \\defgroup "
static const string	DETAILS = "/// \\details "
static const string	GROUP_CLOSE = "/// \\}\n"
static const string	GROUP_OPEN = "/// \\{\n"
static const string	INGROUP = "/// \\ingroup "
static const string	NOTE = "/// \\note "
static const string	PARAM_IN = "/// \\param[in] "
static const string	RETURNS = "/// \\returns "
static const string	SEE = "/// \\see "
static const string	WARNING = "/// \\warning "

Detailed Description

Organization unit for Doxygen commands.

Variable Documentation

ADDTOGROUP

const string ug::DocuGen::Doxygen::ADDTOGROUP = "/// \\addtogroup "

static

BRIEF

const string ug::DocuGen::Doxygen::BRIEF = "/// \\brief "

static

Referenced by ug::DocuGen::CppGenerator::generate_class_constructors(), ug::DocuGen::CppGenerator::generate_class_docu(), ug::DocuGen::CppGenerator::write_brief_detail_docu(), and ug::DocuGen::CppGenerator::write_group_definitions().

CLASS

const string ug::DocuGen::Doxygen::CLASS = "/// \\class "

static

Referenced by ug::DocuGen::CppGenerator::generate_class_docu().

DEFGROUP

const string ug::DocuGen::Doxygen::DEFGROUP = "/// \\defgroup "

static

DETAILS

const string ug::DocuGen::Doxygen::DETAILS = "/// \\details "

static

Referenced by ug::DocuGen::CppGenerator::write_brief_detail_docu().

GROUP_CLOSE

const string ug::DocuGen::Doxygen::GROUP_CLOSE = "/// \\}\n"

static

GROUP_OPEN

const string ug::DocuGen::Doxygen::GROUP_OPEN = "/// \\{\n"

static

INGROUP

const string ug::DocuGen::Doxygen::INGROUP = "/// \\ingroup "

static

NOTE

const string ug::DocuGen::Doxygen::NOTE = "/// \\note "

static

Referenced by ug::DocuGen::CppGenerator::generate_class_group().

PARAM_IN

const string ug::DocuGen::Doxygen::PARAM_IN = "/// \\param[in] "

static

Referenced by ug::DocuGen::CppGenerator::write_parameter_docu().

RETURNS

const string ug::DocuGen::Doxygen::RETURNS = "/// \\returns "

static

Referenced by ug::DocuGen::CppGenerator::generate_return_value().

SEE

const string ug::DocuGen::Doxygen::SEE = "/// \\see "

static

Referenced by ug::DocuGen::CppGenerator::generate_class_group().

WARNING

const string ug::DocuGen::Doxygen::WARNING = "/// \\warning "

static

Referenced by ug::DocuGen::CppGenerator::generate_class_docu(), ug::DocuGen::CppGenerator::write_generic_function(), and ug::DocuGen::CppGenerator::write_group_definitions().