[Doxygen] Various in src/core

This commit is contained in:
Peter D. Barnes, Jr.
2015-01-16 11:55:23 -08:00
parent 32827de86a
commit 2e45a2ffd9
9 changed files with 82 additions and 23 deletions

View File

@@ -436,7 +436,7 @@ private:
/** \ingroup commandline
* \defgroup commandlinehelper Helpers to Specialize on \c bool
* \defgroup commandlinehelper Helpers to Specialize on bool
*/
/**
* \ingroup commandlinehelper

View File

@@ -79,12 +79,12 @@ public:
/// Default constructor.
inline int64x64_t ()
: _v (0) {}
/**@{*/
/**
* Construct from a floating point value.
* \name Construct from a floating point value.
*
* \param [in] value Floating value to represent.
*/
/**@{*/
inline int64x64_t (const double value)
{
const int64x64_t tmp ((long double)value);
@@ -120,12 +120,12 @@ public:
}
/**@}*/
/**@{*/
/**
* Construct from an integral type.
* \name Construct from an integral type.
*
* \param [in] v Integer value to represent.
*/
/**@{*/
inline int64x64_t (const int v)
: _v (v)
{
@@ -157,6 +157,7 @@ public:
_v <<= 64;
}
/**@}*/
/**
* Construct from explicit high and low values.
*

View File

@@ -46,6 +46,7 @@ namespace ns3 {
/**
* \ingroup logging
* The LogTimePrinter.
* This is private to the logging implementation.
*/
static LogTimePrinter g_logTimePrinter = 0;
/**
@@ -58,6 +59,7 @@ static LogNodePrinter g_logNodePrinter = 0;
* \ingroup logging
* Handler for \c print-list token in NS_LOG
* to print the list of log components.
* This is private to the logging implementation.
*/
class PrintList
{
@@ -65,7 +67,10 @@ public:
PrintList (); //<! Constructor, prints the list and exits.
};
/** Invoke handler for \c print-list in NS_LOG environment variable. */
/**
* Invoke handler for \c print-list in NS_LOG environment variable.
* This is private to the logging implementation.
*/
static PrintList g_printList;
@@ -479,7 +484,9 @@ LogComponentPrintList (void)
}
/**
* \ingroup
* Check if a log component exists.
* This is private to the logging implementation.
*
* \param componentName The putative log component name.
* \returns \c true if \c componentName exists.
@@ -505,6 +512,7 @@ static bool ComponentExists(std::string componentName)
/**
* Parse the \c NS_LOG environment variable.
* This is private to the logging implementation.
*/
static void CheckEnvironmentVariables (void)
{

View File

@@ -145,9 +145,13 @@ public:
Mark (this);
}
}
/**
* \name Numeric constructors.
* Construct from a numeric value.
* @{
*/
/**
* Construct from a numeric value.
*
* The current time resolution will be assumed as the unit.
* \param [in] v The value.
* @{
@@ -217,6 +221,7 @@ public:
}
}
/**@}*/
/**@}*/
/**
* \brief Construct Time object from common time expressions like "1ms"
@@ -803,7 +808,7 @@ std::istream & operator >> (std::istream & is, Time & time);
/**
* \ingroup time
* \defgroup timecivil Standard time units.
* \defgroup timecivil Standard Time Units.
* \brief Convenience constructors in standard units.
*
* For example:
@@ -913,19 +918,8 @@ inline Time TimeStep (uint64_t ts)
return Time (ts);
}
/**
* \ingroup time
* \class ns3::TimeValue
* \brief Attribute for objects of type ns3::Time
*/
ATTRIBUTE_VALUE_DEFINE (Time);
/**
* Attribute accessor function for Time
* @{
*/
ATTRIBUTE_ACCESSOR_DEFINE (Time);
/**@}*/
/**
* \ingroup time

View File

@@ -61,12 +61,12 @@ public:
*/
ObjectFactory (std::string typeId);
/**@{*/
/**
* Set the TypeId of the Objects to be created by this factory.
*
* \param tid The TypeId of the object to instantiate.
*/
/**@{*/
void SetTypeId (TypeId tid);
void SetTypeId (const char *tid);
void SetTypeId (std::string tid);
@@ -184,6 +184,11 @@ ATTRIBUTE_HELPER_HEADER (ObjectFactory);
} // namespace ns3
/***************************************************************
* Implementation of the templates declared above.
***************************************************************/
namespace ns3 {
template <typename T>

View File

@@ -22,7 +22,6 @@
#include "object.h"
#include "object-factory.h"
#include "assert.h"
#include "singleton.h"
#include "attribute.h"
#include "log.h"
#include "string.h"