Doxyrest Manual
2.1
Motivation
Architectural Overview
Basic Usage
Advanced Topics
Reference
Samples
Doxyrest Manual
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
Symbols
--config
command line option
--define
command line option
--frame
command line option
--frame-dir
command line option
--help
command line option
--output
command line option
--version
command line option
-c
command line option
-D
command line option
-F
command line option
-f
command line option
-h
command line option
-o
command line option
-v
command line option
A
Alias
table
aliasArray
variable
argString
variable
,
[1]
,
[2]
,
[3]
,
[4]
array
variable
B
bitField
variable
blockKind
variable
briefDescription
variable
,
[1]
,
[2]
,
[3]
,
[4]
C
childBlockList
variable
Class
table
classArray
variable
command line option
--config
--define
--frame
--frame-dir
--help
--output
--version
-c
-D
-f
-F
-h
-o
-v
Compound
table
CompoundKind
enum
compoundKind
variable
,
[1]
constructorArray
variable
CREF_DB
variable
D
declarationName
variable
defaultValue
variable
Define
table
defineArray
variable
definitionName
variable
Description
table
destructor
variable
detailedDescription
variable
,
[1]
,
[2]
DocAnchorBlock
table
DocBlock
table
DocBlockKind
enum
docBlockList
variable
DocImageBlock
table
DocRefBlock
table
DocSectionBlock
table
DocSimpleSectionBlock
table
DocUlinkBlock
table
Doxygen Auxillary Types
group
Doxygen Compounds
group
Doxygen Documentation Blocks
group
Doxygen Members
group
Doxyrest Global Variables
group
E
emit
function
Enum
table
enum
CompoundKind
DocBlockKind
ImageKind
MemberFlag
MemberKind
ProtectionKind
RefKind
VirtualKind
enumArray
variable
EnumValue
table
enumValueArray
variable
ESCAPE_ASTERISKS
variable
ESCAPE_PIPES
variable
ESCAPE_TRAILING_UNDERSCORES
variable
Event
table
eventArray
variable
exceptions
variable
EXCLUDE_DEFAULT_CONSTRUCTORS
variable
EXCLUDE_DEFINE_PATTERN
variable
EXCLUDE_DESTRUCTORS
variable
EXCLUDE_EMPTY_DEFINES
variable
EXCLUDE_LOCATION_PATTERN
variable
EXCLUDE_LUA_LOCALS
variable
EXCLUDE_PRIMITIVE_TYPEDEFS
variable
EXCLUDE_UNDOCUMENTED_ITEMS
variable
EXTERNAL_CREF_DB
variable
EXTRA_PAGE_LIST
variable
F
flags
variable
FOOTNOTE_MEMBER_PREFIX
variable
footnoteArray
variable
FORCE_INCLUDE_FILE
variable
Frame Settings
group
FRAME_DIR_LIST
variable
FRAME_FILE
variable
Function
table
function
emit
generateFile
getCol
getLine
getLineText
includeFile
includeFileWithIndent
passthrough
trimOutput
functionArray
variable
G
g_frameDir
variable
g_globalNamespace
variable
g_groupArray
variable
g_pageArray
variable
g_targetDir
variable
g_targetFileName
variable
generateFile
function
getCol
function
getLine
function
getLineText
function
GLOBAL_AUX_COMPOUND_ID
variable
GlobalNamespace
table
Group
table
group
Doxygen Auxillary Types
Doxygen Compounds
Doxygen Documentation Blocks
Doxygen Members
Doxyrest Global Variables
Frame Settings
Lua Frame API
String templating API functions
groupArray
variable
H
HEADING_TO_RUBRIC
variable
I
id
variable
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
,
[6]
ImageKind
enum
imageKind
variable
inBodyDescription
variable
includeFile
function
includeFileWithIndent
function
INDEX_TITLE
variable
initializer
variable
,
[1]
,
[2]
,
[3]
INPUT_FILE
variable
INTRO_FILE
variable
isEmpty
variable
,
[1]
L
LANGUAGE
variable
LinkedText
table
Location
table
location
variable
,
[1]
Lua Frame API
group
M
Member
table
MemberFlag
enum
MemberKind
enum
memberKind
variable
,
[1]
ML_PARAM_LIST_COUNT_THRESHOLD
variable
ML_PARAM_LIST_LENGTH_THRESHOLD
variable
ML_SPECIFIER_MODIFIER_LIST
variable
modifiers
variable
N
name
variable
,
[1]
,
[2]
namespaceArray
variable
NamespaceContents
table
O
originalIdx
variable
OUTPUT_FILE
variable
P
Page
table
Param
table
paramArray
variable
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
passthrough
function
path
variable
,
[1]
plainText
variable
PRE_BODY_NL
variable
PRE_OPERATOR_NAME_SPACE
variable
PRE_OPERATOR_PARAM_LIST_SPACE
variable
PRE_PARAM_LIST_SPACE
variable
Property
table
propertyArray
variable
PROTECTION_FILTER
variable
ProtectionKind
enum
protectionKind
variable
,
[1]
R
RefKind
enum
refKind
variable
,
[1]
RefText
table
refTextArray
variable
returnType
variable
,
[1]
S
SECTION_TO_RUBRIC
variable
SHOW_DIRECT_DESCENDANTS
variable
simpleSectionKind
variable
SORT_GROUPS_BY
variable
String templating API functions
group
structArray
variable
T
table
Alias
Class
Compound
Define
Description
DocAnchorBlock
DocBlock
DocImageBlock
DocRefBlock
DocSectionBlock
DocSimpleSectionBlock
DocUlinkBlock
Enum
EnumValue
Event
Function
GlobalNamespace
Group
LinkedText
Location
Member
NamespaceContents
Page
Param
Property
RefText
Typedef
Variable
templateParamArray
variable
,
[1]
templateSpecParamArray
variable
,
[1]
text
variable
,
[1]
title
variable
,
[1]
trimOutput
function
type
variable
,
[1]
,
[2]
,
[3]
Typedef
table
TYPEDEF_TO_USING
variable
typedefArray
variable
U
unionArray
variable
V
Variable
table
variable
aliasArray
argString
,
[1]
,
[2]
,
[3]
,
[4]
array
bitField
blockKind
briefDescription
,
[1]
,
[2]
,
[3]
,
[4]
childBlockList
classArray
compoundKind
,
[1]
constructorArray
CREF_DB
declarationName
defaultValue
defineArray
definitionName
destructor
detailedDescription
,
[1]
,
[2]
docBlockList
enumArray
enumValueArray
ESCAPE_ASTERISKS
ESCAPE_PIPES
ESCAPE_TRAILING_UNDERSCORES
eventArray
exceptions
EXCLUDE_DEFAULT_CONSTRUCTORS
EXCLUDE_DEFINE_PATTERN
EXCLUDE_DESTRUCTORS
EXCLUDE_EMPTY_DEFINES
EXCLUDE_LOCATION_PATTERN
EXCLUDE_LUA_LOCALS
EXCLUDE_PRIMITIVE_TYPEDEFS
EXCLUDE_UNDOCUMENTED_ITEMS
EXTERNAL_CREF_DB
EXTRA_PAGE_LIST
flags
FOOTNOTE_MEMBER_PREFIX
footnoteArray
FORCE_INCLUDE_FILE
FRAME_DIR_LIST
FRAME_FILE
functionArray
g_frameDir
g_globalNamespace
g_groupArray
g_pageArray
g_targetDir
g_targetFileName
GLOBAL_AUX_COMPOUND_ID
groupArray
HEADING_TO_RUBRIC
id
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
,
[6]
imageKind
inBodyDescription
INDEX_TITLE
initializer
,
[1]
,
[2]
,
[3]
INPUT_FILE
INTRO_FILE
isEmpty
,
[1]
LANGUAGE
location
,
[1]
memberKind
,
[1]
ML_PARAM_LIST_COUNT_THRESHOLD
ML_PARAM_LIST_LENGTH_THRESHOLD
ML_SPECIFIER_MODIFIER_LIST
modifiers
name
,
[1]
,
[2]
namespaceArray
originalIdx
OUTPUT_FILE
paramArray
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
path
,
[1]
plainText
PRE_BODY_NL
PRE_OPERATOR_NAME_SPACE
PRE_OPERATOR_PARAM_LIST_SPACE
PRE_PARAM_LIST_SPACE
propertyArray
PROTECTION_FILTER
protectionKind
,
[1]
refKind
,
[1]
refTextArray
returnType
,
[1]
SECTION_TO_RUBRIC
SHOW_DIRECT_DESCENDANTS
simpleSectionKind
SORT_GROUPS_BY
structArray
templateParamArray
,
[1]
templateSpecParamArray
,
[1]
text
,
[1]
title
,
[1]
type
,
[1]
,
[2]
,
[3]
TYPEDEF_TO_USING
typedefArray
unionArray
variableArray
VERBATIM_TO_CODE_BLOCK
virtualKind
variableArray
variable
VERBATIM_TO_CODE_BLOCK
variable
VirtualKind
enum
virtualKind
variable