Entity

struct Entity

Entity in a C++ source file, e.g. variable, function, class, etc.

Types

Name	Description
list_type	Child entities are stored in a list, rather than map by name, to preserve declaration order.

Variables

Name	Description
namespaces	Child namespaces.
groups	Child groups.
types	Child types.
concepts	Child concepts.
variables	Child variables.
functions	Child functions.
operators	Child operators.
enums	Child enumerators.
macros	Child macros.
name	Entity name (e.g. name of variable, function, class).
decl	Entity declaration (e.g. function signature).
docs	Entity documentation.
title	Entity title.
brief	Alternative brief description.
ingroup	Group to which this belongs.
file	Source file of the entity.
start_line	Starting line of the entity.
middle_line	Starting line of the body.
end_line	Ending line of the entity.
indent	Current indent level of the documentation comment for this entity.
type	Entity type.
hide	Hide this node?

Functions

Name	Description
Entity	Constructor.
empty	Is the entity empty?
add	Add child entity.
merge	Merge the children of another entity into this one.
addToGroup	Add child entity to a group.
addToThis	Add child entity.

Variable Details

brief

std::string brief

Alternative brief description.

concepts

list_type concepts

Child concepts.

decl

std::string decl

Entity declaration (e.g. function signature).

docs

std::string docs

Entity documentation.

end_line

int end_line

Ending line of the entity.

enums

list_type enums

Child enumerators.

file

std::string file

Source file of the entity.

functions

list_type functions

Child functions.

groups

list_type groups

Child groups.

hide

bool hide

Hide this node?

indent

int indent

Current indent level of the documentation comment for this entity.

ingroup

std::string ingroup

Group to which this belongs.

macros

list_type macros

Child macros.

middle_line

int middle_line

Starting line of the body. If there is no body, e.g. this is a declaration only, then equals end_line.

name

std::string name

Entity name (e.g. name of variable, function, class).

namespaces

list_type namespaces

Child namespaces.

operators

list_type operators

Child operators.

start_line

int start_line

Starting line of the entity.

title

std::string title

Entity title. This is used for the title of the page.

type

EntityType type

Entity type.

types

list_type types

Child types.

variables

list_type variables

Child variables.

Function Details

Entity

Entity()

Constructor.

add

void add(const Entity& o)

Add child entity.

o

Child entity.

If the child has ingroup set, then will search for and add to that group instead.

addToGroup

bool addToGroup(const Entity& o)

Add child entity to a group.

o

Child entity with ingroup set.

Return

True if a group of the given name was found, in which case o will have been added to it, false otherwise.

addToThis

void addToThis(const Entity& o)

Add child entity.

o

Child entity.

If the child has ingroup set, it is ignored.

empty

bool empty() const

Is the entity empty? i.e. does it have no children.

merge

void merge(const Entity& o)

Merge the children of another entity into this one.

o

Other entity.