doc: Add to doxygen a list of all TypeIds

This commit is contained in:
Parth Pandya
2020-02-03 15:49:55 -08:00
committed by Peter D. Barnes, Jr
parent 60680946bb
commit 741fd9feee
3 changed files with 49 additions and 0 deletions

View File

@@ -164,6 +164,7 @@ Alfonso Oliveira (af.oliveira.16@gmail.com)
Luis Pacheco (luisbelem@gmail.com)
Jendaipou Palmei (jendaipoupalmei@gmail.com)
Lluís Parcerisa (parcerisa@gmail.com)
Parth Pandya (parthpandyappp@gmail.com)
Mingyu Park (darkpmg@naver.com)
Jendaipou Palmei (jendaipoupalmei@gmail.com)
Natale Patriciello (natale.patriciello@gmail.com)

View File

@@ -31,6 +31,7 @@ Bugs fixed
- Issue #84 - Wi-Fi removing wrong header due to copy-paste error
- wifi: a zero value for the backoff timer might be discarded and a new value
might be generated by an erroneous call to NotifyCollision().
- Bug 2636 - Add to doxygen a list of all registered TypeIds
Known issues
------------

View File

@@ -976,6 +976,52 @@ PrintTypeIdBlocks (std::ostream & os)
* Lists of All things
***************************************************************/
/**
* Print the list of all TypeIds
*
* \param [in,out] os The output stream.
*/
void
PrintAllTypeIds (std::ostream & os)
{
NS_LOG_FUNCTION_NOARGS ();
os << commentStart << page << "TypeIdList All TypeIds\n"
<< std::endl;
os << "This is a list of all" << reference << "TypeIds.\n"
<< "For more information see the" << reference << "TypeId "
<< "section of this API documentation and the TypeId section "
<< "in the Configuration and Attributes chapter of the Manual.\n"
<< std::endl;
os << listStart << std::endl;
NameMap nameMap = GetNameMap ();
// Iterate over the map, which will print the class names in
// alphabetical order.
for (auto item : nameMap)
{
// Handle only real TypeIds
if (item.second < 0)
{
continue ;
}
// Get the class's index out of the map;
TypeId tid = TypeId::GetRegistered (item.second);
os << indentHtmlOnly
<< listLineStart
<< boldStart
<< tid.GetName ()
<< boldStop
<< listLineStop
<< std::endl;
}
os << commentStop << std::endl;
} // PrintAllTypeIds ()
/**
* Print the list of all Attributes.
*
@@ -1569,6 +1615,7 @@ int main (int argc, char *argv[])
PrintTypeIdBlocks (std::cout);
PrintAllTypeIds (std::cout);
PrintAllAttributes (std::cout);
PrintAllGlobals (std::cout);
PrintAllLogComponents (std::cout);