Generate documentation from the TypeId database. More...
#include "ns3/command-line.h"
#include "ns3/config.h"
#include "ns3/global-value.h"
#include "ns3/log.h"
#include "ns3/node-container.h"
#include "ns3/object-vector.h"
#include "ns3/object.h"
#include "ns3/pointer.h"
#include "ns3/simple-channel.h"
#include "ns3/string.h"
#include "ns3/system-path.h"
#include <algorithm>
#include <climits>
#include <iomanip>
#include <iostream>
#include <map>
#include <utility>
Go to the source code of this file.
Classes | |
struct | AttributeDescriptor |
Descriptor for an AttributeValue. More... | |
class | StaticInformation |
Gather aggregation and configuration path information from registered types. More... | |
Namespaces | |
namespace | anonymous_namespace{print-introspected-doxygen.cc} |
Typedefs | |
using | GroupList_t = std::set<TypeId> |
List of TypeIds for a group. | |
using | GroupsList_t = std::map<std::string, GroupList_t> |
Collection of group names with associated TypeIds. | |
typedef std::map< std::string, int32_t > | NameMap |
Map from TypeId name to tid. | |
typedef NameMap::const_iterator | NameMapIterator |
NameMap iterator. | |
Functions | |
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. | |
GroupsList_t | GetGroupsList () |
Get a sorted list of TypeId groups. | |
NameMap | GetNameMap () |
Create a map from the class names to their index in the vector of TypeId's so that the names will end up in alphabetical order. | |
StaticInformation | GetTypicalAggregations () |
Register aggregation relationships that are not automatically detected by this introspection program. | |
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. | |
void | PrintAllAttributes (std::ostream &os) |
Print the list of all Attributes. | |
void | PrintAllGlobals (std::ostream &os) |
Print the list of all global variables. | |
void | PrintAllGroups (std::ostream &os) |
Print the list of all groups. | |
void | PrintAllLogComponents (std::ostream &os) |
Print the list of all LogComponents. | |
void | PrintAllTraceSources (std::ostream &os) |
Print the list of all Trace sources. | |
void | PrintAllTypeIds (std::ostream &os) |
Print the list of all TypeIds. | |
void | PrintAttributeHelper (std::ostream &os, const AttributeDescriptor &attr) |
Print documentation corresponding to use of the ATTRIBUTE_HELPER_HEADER macro or ATTRIBUTE_VALUE_DEFINE_WITH_NAME macro. | |
void | PrintAttributeImplementations (std::ostream &os) |
Print documentation for Attribute implementations. | |
void | PrintAttributes (std::ostream &os, const TypeId tid) |
Print the Attributes block for tid, including Attributes declared in base classes. | |
void | PrintAttributesTid (std::ostream &os, const TypeId tid) |
Print direct Attributes for this TypeId. | |
void | PrintAttributeValueSection (std::ostream &os, const std::string &name, const bool seeBase=true) |
Print the section definition for an AttributeValue. | |
void | PrintAttributeValueWithName (std::ostream &os, const std::string &name, const std::string &type, const std::string &header) |
Print the AttributeValue documentation for a class. | |
void | PrintConfigPaths (std::ostream &os, const TypeId tid) |
Print config paths. | |
void | PrintMakeAccessors (std::ostream &os, const std::string &name) |
Print the AttributeValue MakeAccessor documentation for a class. | |
void | PrintMakeChecker (std::ostream &os, const std::string &name, const std::string &header) |
Print the AttributeValue MakeChecker documentation for a class. | |
void | PrintSize (std::ostream &os, const TypeId tid) |
Print the size of the type represented by this tid. | |
void | PrintSupportLevel (std::ostream &os, TypeId::SupportLevel supportLevel, std::string supportMsg) |
Print the support level for an Attribute or TraceSource. | |
void | PrintTraceSources (std::ostream &os, const TypeId tid) |
Print the Trace sources block for tid, including Trace sources declared in base classes. | |
void | PrintTraceSourcesTid (std::ostream &os, const TypeId tid) |
Print direct Trace sources for this TypeId. | |
void | PrintTypeIdBlock (std::ostream &os, const TypeId tid) |
Print the doxy block for a single TypeId. | |
void | PrintTypeIdBlocks (std::ostream &os) |
Print the doxy block for each TypeId. | |
void | SetMarkup () |
Initialize the markup strings, for either doxygen or text. | |
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. | |
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. | |
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. | |
template<typename T> | |
void | Uniquefy (T t) |
Helper to keep only the unique items in a container. | |
Generate documentation from the TypeId database.
Definition in file print-introspected-doxygen.cc.
using GroupList_t = std::set<TypeId> |
List of TypeIds for a group.
Definition at line 719 of file print-introspected-doxygen.cc.
using GroupsList_t = std::map<std::string, GroupList_t> |
Collection of group names with associated TypeIds.
Definition at line 721 of file print-introspected-doxygen.cc.
Map from TypeId name to tid.
Definition at line 662 of file print-introspected-doxygen.cc.
typedef NameMap::const_iterator NameMapIterator |
NameMap iterator.
Definition at line 663 of file print-introspected-doxygen.cc.
GroupsList_t GetGroupsList | ( | ) |
Get a sorted list of TypeId groups.
Definition at line 728 of file print-introspected-doxygen.cc.
References ns3::TypeId::GetGroupName(), GetNameMap(), and ns3::TypeId::GetRegistered().
Referenced by PrintAllGroups().
NameMap GetNameMap | ( | ) |
Create a map from the class names to their index in the vector of TypeId's so that the names will end up in alphabetical order.
Definition at line 672 of file print-introspected-doxygen.cc.
References ns3::TypeId::GetName(), StaticInformation::GetNoTypeIds(), ns3::TypeId::GetRegistered(), ns3::TypeId::GetRegisteredN(), GetTypicalAggregations(), ns3::TypeId::MustHideFromDocumentation(), ns3::TypeId::AttributeInformation::name, and NS_LOG_FUNCTION_NOARGS.
Referenced by GetGroupsList(), PrintAllAttributes(), PrintAllTraceSources(), PrintAllTypeIds(), and PrintTypeIdBlocks().
StaticInformation GetTypicalAggregations | ( | ) |
Register aggregation relationships that are not automatically detected by this introspection program.
Statements added here result in more configuration paths being added to the doxygen.
Definition at line 603 of file print-introspected-doxygen.cc.
References ns3::CreateObject(), StaticInformation::Gather(), ns3::Config::GetRootNamespaceObject(), ns3::Config::GetRootNamespaceObjectN(), NS_LOG_FUNCTION_NOARGS, and StaticInformation::RecordAggregationInfo().
Referenced by GetNameMap(), and PrintConfigPaths().
void PrintAllAttributes | ( | std::ostream & | os | ) |
Print the list of all Attributes.
[in,out] | os | The output stream. |
Definition at line 1173 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::breakHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, ns3::TypeId::GetAttributeN(), ns3::TypeId::GetName(), GetNameMap(), ns3::TypeId::GetRegistered(), anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION_NOARGS, anonymous_namespace{print-introspected-doxygen.cc}::page, anonymous_namespace{print-introspected-doxygen.cc}::reference, and anonymous_namespace{print-introspected-doxygen.cc}::SortedAttributeInfo().
void PrintAllGlobals | ( | std::ostream & | os | ) |
Print the list of all global variables.
[in,out] | os | The output stream. |
Definition at line 1222 of file print-introspected-doxygen.cc.
References ns3::GlobalValue::Begin(), anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, ns3::GlobalValue::End(), ns3::StringValue::Get(), anonymous_namespace{print-introspected-doxygen.cc}::hrefMid, anonymous_namespace{print-introspected-doxygen.cc}::hrefStart, anonymous_namespace{print-introspected-doxygen.cc}::hrefStop, anonymous_namespace{print-introspected-doxygen.cc}::indentHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, NS_LOG_FUNCTION_NOARGS, anonymous_namespace{print-introspected-doxygen.cc}::page, and anonymous_namespace{print-introspected-doxygen.cc}::reference.
void PrintAllGroups | ( | std::ostream & | os | ) |
Print the list of all groups.
[in,out] | os | The output stream. |
Definition at line 1250 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::breakHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, GetGroupsList(), anonymous_namespace{print-introspected-doxygen.cc}::hrefMid, anonymous_namespace{print-introspected-doxygen.cc}::hrefStart, anonymous_namespace{print-introspected-doxygen.cc}::hrefStop, anonymous_namespace{print-introspected-doxygen.cc}::indentHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, NS_LOG_FUNCTION_NOARGS, and anonymous_namespace{print-introspected-doxygen.cc}::page.
void PrintAllLogComponents | ( | std::ostream & | os | ) |
Print the list of all LogComponents.
[in,out] | os | The output stream. |
Definition at line 1282 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, anonymous_namespace{print-introspected-doxygen.cc}::file, ns3::LogComponent::GetComponentList(), NS_LOG_FUNCTION_NOARGS, anonymous_namespace{print-introspected-doxygen.cc}::page, and anonymous_namespace{print-introspected-doxygen.cc}::reference.
void PrintAllTraceSources | ( | std::ostream & | os | ) |
Print the list of all Trace sources.
[in,out] | os | The output stream. |
Definition at line 1344 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::breakHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, ns3::TypeId::GetName(), GetNameMap(), ns3::TypeId::GetRegistered(), ns3::TypeId::GetTraceSourceN(), anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION_NOARGS, anonymous_namespace{print-introspected-doxygen.cc}::page, anonymous_namespace{print-introspected-doxygen.cc}::reference, and anonymous_namespace{print-introspected-doxygen.cc}::SortedTraceSourceInfo().
void PrintAllTypeIds | ( | std::ostream & | os | ) |
Print the list of all TypeIds.
[in,out] | os | The output stream. |
Definition at line 1131 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, ns3::TypeId::GetName(), GetNameMap(), ns3::TypeId::GetRegistered(), anonymous_namespace{print-introspected-doxygen.cc}::indentHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, NS_LOG_FUNCTION_NOARGS, anonymous_namespace{print-introspected-doxygen.cc}::page, anonymous_namespace{print-introspected-doxygen.cc}::reference, and anonymous_namespace{print-introspected-doxygen.cc}::referenceNo.
void PrintAttributeHelper | ( | std::ostream & | os, |
const AttributeDescriptor & | attr ) |
Print documentation corresponding to use of the ATTRIBUTE_HELPER_HEADER macro or ATTRIBUTE_VALUE_DEFINE_WITH_NAME macro.
[in,out] | os | The output stream. |
[in] | attr | The AttributeDescriptor. |
Definition at line 1577 of file print-introspected-doxygen.cc.
References AttributeDescriptor::m_header, AttributeDescriptor::m_name, AttributeDescriptor::m_seeBase, AttributeDescriptor::m_type, NS_LOG_FUNCTION, PrintAttributeValueSection(), PrintAttributeValueWithName(), PrintMakeAccessors(), and PrintMakeChecker().
Referenced by PrintAttributeImplementations().
void PrintAttributeImplementations | ( | std::ostream & | os | ) |
Print documentation for Attribute implementations.
os | The stream to print on. |
Definition at line 1591 of file print-introspected-doxygen.cc.
References NS_LOG_FUNCTION_NOARGS, PrintAttributeHelper(), PrintAttributeValueSection(), PrintMakeAccessors(), and PrintMakeChecker().
void PrintAttributes | ( | std::ostream & | os, |
const TypeId | tid ) |
Print the Attributes block for tid, including Attributes declared in base classes.
All Attributes of this TypeId will be printed, including those defined in parent classes.
[in,out] | os | The output stream. |
[in] | tid | The TypeId to print. |
Definition at line 936 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::breakBoth, ns3::TypeId::GetAttributeN(), ns3::TypeId::GetName(), ns3::TypeId::GetParent(), anonymous_namespace{print-introspected-doxygen.cc}::headingStart, anonymous_namespace{print-introspected-doxygen.cc}::headingStop, anonymous_namespace{print-introspected-doxygen.cc}::HeadingWithId(), NS_LOG_FUNCTION, PrintAttributesTid(), and anonymous_namespace{print-introspected-doxygen.cc}::SpanWithId().
Referenced by PrintTypeIdBlock().
void PrintAttributesTid | ( | std::ostream & | os, |
const TypeId | tid ) |
Print direct Attributes for this TypeId.
Only attributes defined directly by this TypeId will be printed.
[in,out] | os | The output stream. |
[in] | tid | The TypeId to print. |
Definition at line 823 of file print-introspected-doxygen.cc.
References ns3::TypeId::ATTR_CONSTRUCT, ns3::TypeId::ATTR_GET, ns3::TypeId::ATTR_SET, anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::codeWord, anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStart, anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStop, anonymous_namespace{print-introspected-doxygen.cc}::indentHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, anonymous_namespace{print-introspected-doxygen.cc}::outputText, ns3::PeekPointer(), PrintSupportLevel(), anonymous_namespace{print-introspected-doxygen.cc}::reference, and anonymous_namespace{print-introspected-doxygen.cc}::SortedAttributeInfo().
Referenced by PrintAttributes().
void PrintAttributeValueSection | ( | std::ostream & | os, |
const std::string & | name, | ||
const bool | seeBase = true ) |
Print the section definition for an AttributeValue.
In doxygen form this will print a comment block with
* @ingroup attributes * @defgroup attribute_<name>Value <name>Value *
[in,out] | os | The output stream. |
[in] | name | The base name of the resulting AttributeValue type. |
[in] | seeBase | Print a "see also" pointing to the base class. |
Definition at line 1407 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, anonymous_namespace{print-introspected-doxygen.cc}::sectionStart, anonymous_namespace{print-introspected-doxygen.cc}::seeAlso, and anonymous_namespace{print-introspected-doxygen.cc}::subSectionStart.
Referenced by PrintAttributeHelper(), and PrintAttributeImplementations().
void PrintAttributeValueWithName | ( | std::ostream & | os, |
const std::string & | name, | ||
const std::string & | type, | ||
const std::string & | header ) |
Print the AttributeValue documentation for a class.
This will print documentation for the AttributeValue class and methods.
[in,out] | os | The output stream. |
[in] | name | The token to use in defining the accessor name. |
[in] | type | The underlying type name. |
[in] | header | The header file which contains this declaration. |
Definition at line 1436 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::argument, anonymous_namespace{print-introspected-doxygen.cc}::classStart, anonymous_namespace{print-introspected-doxygen.cc}::codeWord, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, anonymous_namespace{print-introspected-doxygen.cc}::functionStart, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, anonymous_namespace{print-introspected-doxygen.cc}::returns, anonymous_namespace{print-introspected-doxygen.cc}::sectionStart, anonymous_namespace{print-introspected-doxygen.cc}::seeAlso, anonymous_namespace{print-introspected-doxygen.cc}::templArgExplicit, anonymous_namespace{print-introspected-doxygen.cc}::templateArgument, and anonymous_namespace{print-introspected-doxygen.cc}::variable.
Referenced by PrintAttributeHelper().
void PrintConfigPaths | ( | std::ostream & | os, |
const TypeId | tid ) |
Print config paths.
os | the output stream |
tid | the type ID |
Definition at line 787 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::breakBoth, anonymous_namespace{print-introspected-doxygen.cc}::breakTextOnly, StaticInformation::Get(), ns3::TypeId::GetName(), GetTypicalAggregations(), anonymous_namespace{print-introspected-doxygen.cc}::HeadingWithId(), anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, NS_LOG_FUNCTION, and anonymous_namespace{print-introspected-doxygen.cc}::SpanWithId().
Referenced by PrintTypeIdBlock().
void PrintMakeAccessors | ( | std::ostream & | os, |
const std::string & | name ) |
Print the AttributeValue MakeAccessor documentation for a class.
This will print documentation for the Make<name>Accessor functions.
[in,out] | os | The output stream. |
[in] | name | The token to use in defining the accessor name. |
Definition at line 1502 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, anonymous_namespace{print-introspected-doxygen.cc}::copyDoc, anonymous_namespace{print-introspected-doxygen.cc}::functionStart, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, anonymous_namespace{print-introspected-doxygen.cc}::sectionStart, and anonymous_namespace{print-introspected-doxygen.cc}::seeAlso.
Referenced by PrintAttributeHelper(), and PrintAttributeImplementations().
void PrintMakeChecker | ( | std::ostream & | os, |
const std::string & | name, | ||
const std::string & | header ) |
Print the AttributeValue MakeChecker documentation for a class.
This will print documentation for the Make<name>Checker function.
[in,out] | os | The output stream. |
[in] | name | The token to use in defining the accessor name. |
[in] | header | The header file which contains this declaration. |
Definition at line 1535 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::classStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, anonymous_namespace{print-introspected-doxygen.cc}::functionStart, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, anonymous_namespace{print-introspected-doxygen.cc}::returns, anonymous_namespace{print-introspected-doxygen.cc}::sectionStart, and anonymous_namespace{print-introspected-doxygen.cc}::seeAlso.
Referenced by PrintAttributeHelper(), and PrintAttributeImplementations().
void PrintSize | ( | std::ostream & | os, |
const TypeId | tid ) |
Print the size of the type represented by this tid.
[in,out] | os | The output stream. |
[in] | tid | The TypeId to print. |
Definition at line 1046 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::BoldWithId(), anonymous_namespace{print-introspected-doxygen.cc}::breakBoth, ns3::TypeId::GetSize(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.
Referenced by PrintTypeIdBlock().
void PrintSupportLevel | ( | std::ostream & | os, |
TypeId::SupportLevel | supportLevel, | ||
std::string | supportMsg ) |
Print the support level for an Attribute or TraceSource.
os | the output stream |
supportLevel | the SupportLevel |
supportMsg | optional support message |
Definition at line 769 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStart, anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStop, anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, ns3::TypeId::AttributeInformation::supportLevel, and ns3::TypeId::AttributeInformation::supportMsg.
Referenced by PrintAttributesTid(), and PrintTraceSourcesTid().
void PrintTraceSources | ( | std::ostream & | os, |
const TypeId | tid ) |
Print the Trace sources block for tid, including Trace sources declared in base classes.
All Trace sources of this TypeId will be printed, including those defined in parent classes.
[in,out] | os | The output stream. |
[in] | tid | The TypeId to print. |
Definition at line 1010 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::breakBoth, ns3::TypeId::GetName(), ns3::TypeId::GetParent(), ns3::TypeId::GetTraceSourceN(), anonymous_namespace{print-introspected-doxygen.cc}::headingStart, anonymous_namespace{print-introspected-doxygen.cc}::headingStop, anonymous_namespace{print-introspected-doxygen.cc}::HeadingWithId(), NS_LOG_FUNCTION, PrintTraceSourcesTid(), and anonymous_namespace{print-introspected-doxygen.cc}::SpanWithId().
Referenced by PrintTypeIdBlock().
void PrintTraceSourcesTid | ( | std::ostream & | os, |
const TypeId | tid ) |
Print direct Trace sources for this TypeId.
Only Trace sources defined directly by this TypeId will be printed.
[in,out] | os | The output stream. |
[in] | tid | The TypeId to print. |
Definition at line 973 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::breakBoth, anonymous_namespace{print-introspected-doxygen.cc}::indentHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, anonymous_namespace{print-introspected-doxygen.cc}::outputText, PrintSupportLevel(), and anonymous_namespace{print-introspected-doxygen.cc}::SortedTraceSourceInfo().
Referenced by PrintTraceSources().
void PrintTypeIdBlock | ( | std::ostream & | os, |
const TypeId | tid ) |
Print the doxy block for a single TypeId.
[in,out] | os | The output stream. |
[in] | tid | the TypeId |
Definition at line 1064 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::BoldWithId(), anonymous_namespace{print-introspected-doxygen.cc}::breakBoth, anonymous_namespace{print-introspected-doxygen.cc}::classStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, ns3::TypeId::GetGroupName(), ns3::TypeId::GetName(), ns3::TypeId::AttributeInformation::name, NS_LOG_FUNCTION, PrintAttributes(), PrintConfigPaths(), PrintSize(), PrintTraceSources(), and anonymous_namespace{print-introspected-doxygen.cc}::SpanWithId().
Referenced by PrintTypeIdBlocks().
void PrintTypeIdBlocks | ( | std::ostream & | os | ) |
Print the doxy block for each TypeId.
[in,out] | os | The output stream. |
Definition at line 1100 of file print-introspected-doxygen.cc.
References GetNameMap(), ns3::TypeId::GetRegistered(), NS_LOG_FUNCTION_NOARGS, and PrintTypeIdBlock().
void SetMarkup | ( | ) |
Initialize the markup strings, for either doxygen or text.
Definition at line 190 of file print-introspected-doxygen.cc.
References anonymous_namespace{print-introspected-doxygen.cc}::anchor, anonymous_namespace{print-introspected-doxygen.cc}::argument, anonymous_namespace{print-introspected-doxygen.cc}::boldStart, anonymous_namespace{print-introspected-doxygen.cc}::boldStop, anonymous_namespace{print-introspected-doxygen.cc}::boldWithIdMid, anonymous_namespace{print-introspected-doxygen.cc}::boldWithIdStart, anonymous_namespace{print-introspected-doxygen.cc}::boldWithIdStop, anonymous_namespace{print-introspected-doxygen.cc}::breakBoth, anonymous_namespace{print-introspected-doxygen.cc}::breakHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::breakTextOnly, anonymous_namespace{print-introspected-doxygen.cc}::brief, anonymous_namespace{print-introspected-doxygen.cc}::classStart, anonymous_namespace{print-introspected-doxygen.cc}::classStop, anonymous_namespace{print-introspected-doxygen.cc}::codeWord, anonymous_namespace{print-introspected-doxygen.cc}::commentStart, anonymous_namespace{print-introspected-doxygen.cc}::commentStop, anonymous_namespace{print-introspected-doxygen.cc}::copyDoc, anonymous_namespace{print-introspected-doxygen.cc}::file, anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStart, anonymous_namespace{print-introspected-doxygen.cc}::flagSpanStop, anonymous_namespace{print-introspected-doxygen.cc}::functionStart, anonymous_namespace{print-introspected-doxygen.cc}::functionStop, anonymous_namespace{print-introspected-doxygen.cc}::headingStart, anonymous_namespace{print-introspected-doxygen.cc}::headingStop, anonymous_namespace{print-introspected-doxygen.cc}::headingWithIdMid, anonymous_namespace{print-introspected-doxygen.cc}::headingWithIdStart, anonymous_namespace{print-introspected-doxygen.cc}::headingWithIdStop, anonymous_namespace{print-introspected-doxygen.cc}::hrefMid, anonymous_namespace{print-introspected-doxygen.cc}::hrefStart, anonymous_namespace{print-introspected-doxygen.cc}::hrefStop, anonymous_namespace{print-introspected-doxygen.cc}::indentHtmlOnly, anonymous_namespace{print-introspected-doxygen.cc}::listLineStart, anonymous_namespace{print-introspected-doxygen.cc}::listLineStop, anonymous_namespace{print-introspected-doxygen.cc}::listStart, anonymous_namespace{print-introspected-doxygen.cc}::listStop, anonymous_namespace{print-introspected-doxygen.cc}::note, NS_LOG_FUNCTION, anonymous_namespace{print-introspected-doxygen.cc}::outputText, anonymous_namespace{print-introspected-doxygen.cc}::page, anonymous_namespace{print-introspected-doxygen.cc}::reference, anonymous_namespace{print-introspected-doxygen.cc}::referenceNo, anonymous_namespace{print-introspected-doxygen.cc}::returns, anonymous_namespace{print-introspected-doxygen.cc}::sectionStart, anonymous_namespace{print-introspected-doxygen.cc}::seeAlso, anonymous_namespace{print-introspected-doxygen.cc}::spanWithIdMid, anonymous_namespace{print-introspected-doxygen.cc}::spanWithIdStart, anonymous_namespace{print-introspected-doxygen.cc}::spanWithIdStop, anonymous_namespace{print-introspected-doxygen.cc}::subSectionStart, anonymous_namespace{print-introspected-doxygen.cc}::templArgDeduced, anonymous_namespace{print-introspected-doxygen.cc}::templArgExplicit, anonymous_namespace{print-introspected-doxygen.cc}::templateArgument, and anonymous_namespace{print-introspected-doxygen.cc}::variable.
void Uniquefy | ( | T | t | ) |
Helper to keep only the unique items in a container.
The container is modified in place; the elements end up sorted.
The container must support begin()
, end()
and erase()
, which, among the STL containers, limits this to std::vector
, std::dequeue
and std::list
.
The container elements must support operator<
(for std::sort
) and operator==
(for std::unique
).
T | [deduced] The container type. |
t | The container. |
Definition at line 491 of file print-introspected-doxygen.cc.
Referenced by StaticInformation::Gather(), and StaticInformation::GetNoTypeIds().