Functions
std::string	BoldWithId (const std::string id, const std::string displayText)
	Generate bold (b) HTML markup with id if not generating text only.

std::string	HeadingWithId (const std::string id, const std::string displayText)
	Generate heading (h3) markup with id if not generating text only.

std::map< std::string, ns3::TypeId::AttributeInformation >	SortedAttributeInfo (const TypeId tid)
	Alphabetize the AttributeInformation for a TypeId by the Attribute name.

std::map< std::string, ns3::TypeId::TraceSourceInformation >	SortedTraceSourceInfo (const TypeId tid)
	Alphabetize the TraceSourceInformation for a TypeId by the TraceSource name.

std::string	SpanWithId (const std::string id, const std::string displayText)
	Generate span (span) HTML markup with id if not generating text only.

Variables
bool	outputText = false
	Are we generating text or Doxygen?


std::string	anchor
	Markup tokens.

std::string	argument
	function argument

std::string	boldStart
	start of bold span

std::string	boldStop
	end of bold span

std::string	boldWithIdStart
	start of bold with id

std::string	boldWithIdMid
	middle of bold span with id

std::string	boldWithIdStop
	end of bold span with id

std::string	breakBoth
	linebreak

std::string	breakHtmlOnly
	linebreak for html output only

std::string	breakTextOnly
	linebreak for text output only

std::string	brief
	brief tag

std::string	classStart
	start of a class

std::string	classStop
	end of a class

std::string	codeWord
	format next word as source code

std::string	commentStart
	start of code comment

std::string	commentStop
	end of code comment

std::string	copyDoc
	copy (or refer) to docs elsewhere

std::string	file
	file

std::string	flagSpanStart
	start of Attribute flag value

std::string	flagSpanStop
	end of Attribute flag value

std::string	functionStart
	start of a method/function

std::string	functionStop
	end of a method/function

std::string	headingStart
	start of section heading (h3)

std::string	headingStop
	end of section heading (h3)

std::string	headingWithIdStart
	start of section heading with id (h3)

std::string	headingWithIdMid
	middle of section heading with id (h3)

std::string	headingWithIdStop
	end of section heading with id (h3)

std::string	hrefStart
	start of a link

std::string	hrefMid
	middle part of a link

std::string	hrefStop
	end of a link

std::string	indentHtmlOnly
	small indent

std::string	listLineStart
	start unordered list item

std::string	listLineStop
	end unordered list item

std::string	listStart
	start unordered list

std::string	listStop
	end unordered list

std::string	note
	start a note section

std::string	page
	start a separate page

std::string	reference
	reference tag

std::string	referenceNo
	block automatic references

std::string	returns
	the return value

std::string	sectionStart
	start of a section or group

std::string	seeAlso
	Reference to other docs.

std::string	spanWithIdStart
	start of span with id

std::string	spanWithIdMid
	middle of span with id

std::string	spanWithIdStop
	end of span with id

std::string	subSectionStart
	start a new subsection

std::string	templArgDeduced
	template argument deduced from function

std::string	templArgExplicit
	template argument required

std::string	templateArgument
	template argument

std::string	variable
	variable or class member

Function Documentation

◆ BoldWithId()

std::string anonymous_namespace{print-introspected-doxygen.cc}::BoldWithId	(	const std::string	id,
		const std::string	displayText )

Generate bold (b) HTML markup with id if not generating text only.

Parameters

id	The element id
displayText	The text to display

Returns: The bold markup with id or just displayText if outputText is true

Definition at line 143 of file print-introspected-doxygen.cc.

References boldWithIdMid, boldWithIdStart, boldWithIdStop, and outputText.

Referenced by PrintSize(), and PrintTypeIdBlock().

Here is the caller graph for this function:

◆ HeadingWithId()

std::string anonymous_namespace{print-introspected-doxygen.cc}::HeadingWithId	(	const std::string	id,
		const std::string	displayText )

Generate heading (h3) markup with id if not generating text only.

Parameters

id	The element id
displayText	The text to display

Returns: The heading markup with id or just displayText if outputText is true

Definition at line 159 of file print-introspected-doxygen.cc.

References headingWithIdMid, headingWithIdStart, headingWithIdStop, and outputText.

Referenced by PrintAttributes(), PrintConfigPaths(), and PrintTraceSources().

Here is the caller graph for this function:

◆ SortedAttributeInfo()

std::map< std::string, ns3::TypeId::AttributeInformation > anonymous_namespace{print-introspected-doxygen.cc}::SortedAttributeInfo ( const TypeId tid )

Alphabetize the AttributeInformation for a TypeId by the Attribute name.

Parameters

tid	The TypeId to process.

Returns: The ordered list of Attributes.

Definition at line 107 of file print-introspected-doxygen.cc.

References ns3::TypeId::GetAttribute(), ns3::TypeId::GetAttributeN(), and ns3::TypeId::AttributeInformation::name.

Referenced by PrintAllAttributes(), and PrintAttributesTid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SortedTraceSourceInfo()

std::map< std::string, ns3::TypeId::TraceSourceInformation > anonymous_namespace{print-introspected-doxygen.cc}::SortedTraceSourceInfo ( const TypeId tid )

Alphabetize the TraceSourceInformation for a TypeId by the TraceSource name.

Parameters

tid	The TypeId to process.

Returns: The ordered list of TraceSourceInformation

Definition at line 125 of file print-introspected-doxygen.cc.

References ns3::TypeId::GetTraceSource(), ns3::TypeId::GetTraceSourceN(), and ns3::TypeId::TraceSourceInformation::name.

Referenced by PrintAllTraceSources(), and PrintTraceSourcesTid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SpanWithId()

std::string anonymous_namespace{print-introspected-doxygen.cc}::SpanWithId	(	const std::string	id,
		const std::string	displayText )

Generate span (span) HTML markup with id if not generating text only.

Parameters

id	The element id
displayText	The text to display

Returns: The span markup with id or just displayText if outputText is true

Definition at line 175 of file print-introspected-doxygen.cc.

References outputText, spanWithIdMid, spanWithIdStart, and spanWithIdStop.

Referenced by PrintAttributes(), PrintConfigPaths(), PrintTraceSources(), and PrintTypeIdBlock().

Here is the caller graph for this function:

Variable Documentation

◆ anchor

std::string anonymous_namespace{print-introspected-doxygen.cc}::anchor

Markup tokens.

hyperlink anchor

Definition at line 47 of file print-introspected-doxygen.cc.

Referenced by SetMarkup().

◆ argument

std::string anonymous_namespace{print-introspected-doxygen.cc}::argument

function argument

Definition at line 48 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueWithName(), and SetMarkup().

◆ boldStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::boldStart

start of bold span

Definition at line 49 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributesTid(), PrintTraceSourcesTid(), and SetMarkup().

◆ boldStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::boldStop

end of bold span

Definition at line 50 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributesTid(), PrintTraceSourcesTid(), and SetMarkup().

◆ boldWithIdMid

std::string anonymous_namespace{print-introspected-doxygen.cc}::boldWithIdMid

middle of bold span with id

Definition at line 52 of file print-introspected-doxygen.cc.

Referenced by BoldWithId(), and SetMarkup().

◆ boldWithIdStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::boldWithIdStart

start of bold with id

Definition at line 51 of file print-introspected-doxygen.cc.

Referenced by BoldWithId(), and SetMarkup().

◆ boldWithIdStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::boldWithIdStop

end of bold span with id

Definition at line 53 of file print-introspected-doxygen.cc.

Referenced by BoldWithId(), and SetMarkup().

◆ breakBoth

std::string anonymous_namespace{print-introspected-doxygen.cc}::breakBoth

linebreak

Definition at line 54 of file print-introspected-doxygen.cc.

Referenced by PrintAttributes(), PrintConfigPaths(), PrintSize(), PrintTraceSources(), PrintTraceSourcesTid(), PrintTypeIdBlock(), and SetMarkup().

◆ breakHtmlOnly

std::string anonymous_namespace{print-introspected-doxygen.cc}::breakHtmlOnly

linebreak for html output only

Definition at line 55 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGroups(), PrintAllTraceSources(), and SetMarkup().

◆ breakTextOnly

std::string anonymous_namespace{print-introspected-doxygen.cc}::breakTextOnly

linebreak for text output only

Definition at line 56 of file print-introspected-doxygen.cc.

Referenced by PrintConfigPaths(), and SetMarkup().

◆ brief

std::string anonymous_namespace{print-introspected-doxygen.cc}::brief

brief tag

Definition at line 57 of file print-introspected-doxygen.cc.

Referenced by SetMarkup().

◆ classStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::classStart

start of a class

Definition at line 58 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueWithName(), PrintMakeChecker(), PrintTypeIdBlock(), and SetMarkup().

◆ classStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::classStop

end of a class

Definition at line 59 of file print-introspected-doxygen.cc.

Referenced by SetMarkup().

◆ codeWord

std::string anonymous_namespace{print-introspected-doxygen.cc}::codeWord

format next word as source code

Definition at line 60 of file print-introspected-doxygen.cc.

Referenced by PrintAttributesTid(), PrintAttributeValueWithName(), and SetMarkup().

◆ commentStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::commentStart

start of code comment

Definition at line 61 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllLogComponents(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributeValueSection(), PrintAttributeValueWithName(), PrintMakeAccessors(), PrintMakeChecker(), PrintTypeIdBlock(), and SetMarkup().

◆ commentStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::commentStop

end of code comment

Definition at line 62 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllLogComponents(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributeValueSection(), PrintAttributeValueWithName(), PrintMakeAccessors(), PrintMakeChecker(), PrintTypeIdBlock(), and SetMarkup().

◆ copyDoc

std::string anonymous_namespace{print-introspected-doxygen.cc}::copyDoc

copy (or refer) to docs elsewhere

Definition at line 63 of file print-introspected-doxygen.cc.

Referenced by PrintMakeAccessors(), and SetMarkup().

◆ file

std::string anonymous_namespace{print-introspected-doxygen.cc}::file

file

Definition at line 64 of file print-introspected-doxygen.cc.

Referenced by PrintAllLogComponents(), and SetMarkup().

◆ flagSpanStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStart

start of Attribute flag value

Definition at line 65 of file print-introspected-doxygen.cc.

Referenced by PrintAttributesTid(), PrintSupportLevel(), and SetMarkup().

◆ flagSpanStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStop

end of Attribute flag value

Definition at line 66 of file print-introspected-doxygen.cc.

Referenced by PrintAttributesTid(), PrintSupportLevel(), and SetMarkup().

◆ functionStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::functionStart

start of a method/function

Definition at line 67 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueWithName(), PrintMakeAccessors(), PrintMakeChecker(), and SetMarkup().

◆ functionStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::functionStop

end of a method/function

Definition at line 68 of file print-introspected-doxygen.cc.

Referenced by SetMarkup().

◆ headingStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::headingStart

start of section heading (h3)

Definition at line 69 of file print-introspected-doxygen.cc.

Referenced by PrintAttributes(), PrintTraceSources(), and SetMarkup().

◆ headingStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::headingStop

end of section heading (h3)

Definition at line 70 of file print-introspected-doxygen.cc.

Referenced by PrintAttributes(), PrintTraceSources(), and SetMarkup().

◆ headingWithIdMid

std::string anonymous_namespace{print-introspected-doxygen.cc}::headingWithIdMid

middle of section heading with id (h3)

Definition at line 72 of file print-introspected-doxygen.cc.

Referenced by HeadingWithId(), and SetMarkup().

◆ headingWithIdStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::headingWithIdStart

start of section heading with id (h3)

Definition at line 71 of file print-introspected-doxygen.cc.

Referenced by HeadingWithId(), and SetMarkup().

◆ headingWithIdStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::headingWithIdStop

end of section heading with id (h3)

Definition at line 73 of file print-introspected-doxygen.cc.

Referenced by HeadingWithId(), and SetMarkup().

◆ hrefMid

std::string anonymous_namespace{print-introspected-doxygen.cc}::hrefMid

middle part of a link

Definition at line 76 of file print-introspected-doxygen.cc.

Referenced by PrintAllGlobals(), PrintAllGroups(), and SetMarkup().

◆ hrefStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::hrefStart

start of a link

Definition at line 75 of file print-introspected-doxygen.cc.

Referenced by PrintAllGlobals(), PrintAllGroups(), and SetMarkup().

◆ hrefStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::hrefStop

end of a link

Definition at line 77 of file print-introspected-doxygen.cc.

Referenced by PrintAllGlobals(), PrintAllGroups(), and SetMarkup().

◆ indentHtmlOnly

std::string anonymous_namespace{print-introspected-doxygen.cc}::indentHtmlOnly

small indent

Definition at line 78 of file print-introspected-doxygen.cc.

Referenced by PrintAllGlobals(), PrintAllGroups(), PrintAllTypeIds(), PrintAttributesTid(), PrintTraceSourcesTid(), and SetMarkup().

◆ listLineStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::listLineStart

start unordered list item

Definition at line 79 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributesTid(), PrintConfigPaths(), PrintSupportLevel(), PrintTraceSourcesTid(), and SetMarkup().

◆ listLineStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::listLineStop

end unordered list item

Definition at line 80 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributesTid(), PrintConfigPaths(), PrintSupportLevel(), PrintTraceSourcesTid(), and SetMarkup().

◆ listStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::listStart

start unordered list

Definition at line 81 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributesTid(), PrintConfigPaths(), PrintTraceSourcesTid(), and SetMarkup().

◆ listStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::listStop

end unordered list

Definition at line 82 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributesTid(), PrintConfigPaths(), PrintTraceSourcesTid(), and SetMarkup().

◆ note

std::string anonymous_namespace{print-introspected-doxygen.cc}::note

start a note section

Definition at line 83 of file print-introspected-doxygen.cc.

Referenced by SetMarkup().

◆ outputText

bool anonymous_namespace{print-introspected-doxygen.cc}::outputText = false

Are we generating text or Doxygen?

Definition at line 41 of file print-introspected-doxygen.cc.

Referenced by BoldWithId(), HeadingWithId(), PrintAttributesTid(), PrintTraceSourcesTid(), SetMarkup(), and SpanWithId().

◆ page

std::string anonymous_namespace{print-introspected-doxygen.cc}::page

start a separate page

Definition at line 84 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllGroups(), PrintAllLogComponents(), PrintAllTraceSources(), PrintAllTypeIds(), and SetMarkup().

◆ reference

std::string anonymous_namespace{print-introspected-doxygen.cc}::reference

reference tag

Definition at line 85 of file print-introspected-doxygen.cc.

Referenced by PrintAllAttributes(), PrintAllGlobals(), PrintAllLogComponents(), PrintAllTraceSources(), PrintAllTypeIds(), PrintAttributesTid(), and SetMarkup().

◆ referenceNo

std::string anonymous_namespace{print-introspected-doxygen.cc}::referenceNo

block automatic references

Definition at line 86 of file print-introspected-doxygen.cc.

Referenced by PrintAllTypeIds(), and SetMarkup().

◆ returns

std::string anonymous_namespace{print-introspected-doxygen.cc}::returns

the return value

Definition at line 87 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueWithName(), PrintMakeChecker(), and SetMarkup().

◆ sectionStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::sectionStart

start of a section or group

Definition at line 88 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueSection(), PrintAttributeValueWithName(), PrintMakeAccessors(), PrintMakeChecker(), and SetMarkup().

◆ seeAlso

std::string anonymous_namespace{print-introspected-doxygen.cc}::seeAlso

Reference to other docs.

Definition at line 89 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueSection(), PrintAttributeValueWithName(), PrintMakeAccessors(), PrintMakeChecker(), and SetMarkup().

◆ spanWithIdMid

std::string anonymous_namespace{print-introspected-doxygen.cc}::spanWithIdMid

middle of span with id

Definition at line 91 of file print-introspected-doxygen.cc.

Referenced by SetMarkup(), and SpanWithId().

◆ spanWithIdStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::spanWithIdStart

start of span with id

Definition at line 90 of file print-introspected-doxygen.cc.

Referenced by SetMarkup(), and SpanWithId().

◆ spanWithIdStop

std::string anonymous_namespace{print-introspected-doxygen.cc}::spanWithIdStop

end of span with id

Definition at line 92 of file print-introspected-doxygen.cc.

Referenced by SetMarkup(), and SpanWithId().

◆ subSectionStart

std::string anonymous_namespace{print-introspected-doxygen.cc}::subSectionStart

start a new subsection

Definition at line 93 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueSection(), and SetMarkup().

◆ templArgDeduced

std::string anonymous_namespace{print-introspected-doxygen.cc}::templArgDeduced

template argument deduced from function

Definition at line 94 of file print-introspected-doxygen.cc.

Referenced by SetMarkup().

◆ templArgExplicit

std::string anonymous_namespace{print-introspected-doxygen.cc}::templArgExplicit

template argument required

Definition at line 95 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueWithName(), and SetMarkup().

◆ templateArgument

std::string anonymous_namespace{print-introspected-doxygen.cc}::templateArgument

template argument

Definition at line 96 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueWithName(), and SetMarkup().

◆ variable

std::string anonymous_namespace{print-introspected-doxygen.cc}::variable

variable or class member

Definition at line 97 of file print-introspected-doxygen.cc.

Referenced by PrintAttributeValueWithName(), and SetMarkup().

Functions

Variables

Function Documentation

◆ BoldWithId()

◆ HeadingWithId()

◆ SortedAttributeInfo()

◆ SortedTraceSourceInfo()

◆ SpanWithId()

Variable Documentation

◆ anchor

◆ argument

◆ boldStart

◆ boldStop

◆ boldWithIdMid

◆ boldWithIdStart

◆ boldWithIdStop

◆ breakBoth

◆ breakHtmlOnly

◆ breakTextOnly

◆ brief

◆ classStart

◆ classStop

◆ codeWord

◆ commentStart

◆ commentStop

◆ copyDoc

◆ file

◆ flagSpanStart

◆ flagSpanStop

◆ functionStart

◆ functionStop

◆ headingStart

◆ headingStop

◆ headingWithIdMid

◆ headingWithIdStart

◆ headingWithIdStop

◆ hrefMid

◆ hrefStart

◆ hrefStop

◆ indentHtmlOnly

◆ listLineStart

◆ listLineStop

◆ listStart

◆ listStop

◆ note

◆ outputText

◆ page

◆ reference

◆ referenceNo

◆ returns

◆ sectionStart

◆ seeAlso

◆ spanWithIdMid

◆ spanWithIdStart

◆ spanWithIdStop

◆ subSectionStart

◆ templArgDeduced

◆ templArgExplicit

◆ templateArgument

◆ variable