[Doxygen] Files implementing attributes.

This commit is contained in:
Peter D. Barnes, Jr.
2015-01-07 15:43:53 -08:00
parent 26fde12a8c
commit 90cf5b60a2
28 changed files with 229 additions and 6 deletions

View File

@@ -22,6 +22,12 @@
#include "attribute.h"
/**
* \file
* \ingroup attributeimpl
* ns3::MakeAccessorHelper declarations and template implementations.
*/
namespace ns3 {

View File

@@ -20,6 +20,12 @@
#include "attribute-construction-list.h"
#include "log.h"
/**
* \file
* \ingroup object
* ns3::AttributeConstructionList implementation.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE("AttributeConstructionList");

View File

@@ -23,6 +23,12 @@
#include "attribute.h"
#include <list>
/**
* \file
* \ingroup object
* ns3::AttributeConstructionList declaration.
*/
namespace ns3 {
/**

View File

@@ -25,6 +25,12 @@
#include <sstream>
#include "fatal-error.h"
/**
* \file
* \ingroup attributehelper
* Declaration of Attribute helper macros.
*/
namespace ns3 {
/**

View File

@@ -23,6 +23,13 @@
#include "string.h"
#include <sstream>
/**
* \file
* \ingroup attribute
* ns3::AttributeValue, ns3::AttributeAccessor and
* ns3::AttributeChecker implementations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("AttributeValue");

View File

@@ -25,6 +25,13 @@
#include "ptr.h"
#include "simple-ref-count.h"
/**
* \file
* \ingroup attribute
* ns3::AttributeValue, ns3::AttributeAccessor and
* ns3::AttributeChecker declarations.
*/
namespace ns3 {
class AttributeAccessor;
@@ -219,7 +226,11 @@ public:
};
/** A class for an empty attribute value. */
/**
* \brief A class for an empty attribute value.
*
* \ingroup attribute
*/
class EmptyAttributeValue : public AttributeValue
{
public:

View File

@@ -21,6 +21,12 @@
#include "fatal-error.h"
#include "log.h"
/**
* \file
* \ingroup attribute_Boolean
* Boolean attribute value implementaations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Boolean");

View File

@@ -23,6 +23,12 @@
#include "attribute.h"
#include "attribute-helper.h"
/**
* \file
* \ingroup attribute_Boolean
* Boolean attribute value declarations.
*/
namespace ns3 {
class BooleanValue : public AttributeValue

View File

@@ -22,14 +22,30 @@
#include "log.h"
#include <sstream>
/**
* \file
* \ingroup attribute_Double
* Double attribute value implementations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Double");
ATTRIBUTE_VALUE_IMPLEMENT_WITH_NAME (double, Double);
/** Namespace for implementation details. */
namespace internal {
/**
* \ingroup attribute_Double
* Make a Double attribute checker with embedded numeric type name.
*
* \param min The minimum allowed value.
* \param max The maximum allowed value.
* \param name The original type name ("float", "double").
* \returns The AttributeChecker.
*/
Ptr<const AttributeChecker> MakeDoubleChecker (double min, double max, std::string name)
{
NS_LOG_FUNCTION (min << max << name);

View File

@@ -25,6 +25,12 @@
#include <stdint.h>
#include <limits>
/**
* \file
* \ingroup attribute_Double
* Double attribute value declarations and template implementations.
*/
namespace ns3 {
// Additional docs for class DoubleValue:
@@ -66,6 +72,11 @@ Ptr<const AttributeChecker> MakeDoubleChecker (double min, double max);
} // namespace ns3
/***************************************************************
* Implementation of the templates declared above.
***************************************************************/
#include "type-name.h"
namespace ns3 {

View File

@@ -22,6 +22,12 @@
#include "log.h"
#include <sstream>
/**
* \file
* \ingroup attribute_Enum
* Enum attribute value implementations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Enum");

View File

@@ -24,9 +24,15 @@
#include "attribute-accessor-helper.h"
#include <list>
/**
* \file
* \ingroup attribute_Enum
* Enum attribute value declarations.
*/
namespace ns3 {
// Additional docs for class DoubleValue:
// Additional docs for class EnumValue:
/**
* Hold variables of type \c enum
*

View File

@@ -22,6 +22,12 @@
#include "log.h"
#include <sstream>
/**
* \file
* \ingroup attribute_Integer
* Integer attribute value implementations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Integer");
@@ -30,6 +36,15 @@ ATTRIBUTE_VALUE_IMPLEMENT_WITH_NAME (int64_t, Integer);
namespace internal {
/**
* \ingroup attribute_Integer
* Make an Integer attribute checker with embedded numeric type name.
*
* \param min The minimum allowed value.
* \param max The maximum allowed value.
* \param name The original type name ("int8_t", "int16_t", _etc_.).
* \returns The AttributeChecker.
*/
Ptr<const AttributeChecker>
MakeIntegerChecker (int64_t min, int64_t max, std::string name)
{

View File

@@ -25,9 +25,15 @@
#include <stdint.h>
#include <limits>
/**
* \file
* \ingroup attribute_Integer
* Integer attribute value declarations and template implementations.
*/
namespace ns3 {
// Additional docs for class DoubleValue:
// Additional docs for class IntegerValue:
/**
* Hold a signed integer type
*
@@ -68,6 +74,11 @@ Ptr<const AttributeChecker> MakeIntegerChecker (int64_t min, int64_t max);
} // namespace ns3
/***************************************************************
* Implementation of the templates declared above.
***************************************************************/
#include "type-name.h"
namespace ns3 {

View File

@@ -25,6 +25,12 @@
#include "attribute.h"
#include "object-ptr-container.h"
/**
* \file
* \ingroup attribute_ObjectMap
* ObjectMap attribute value declarations and template implementations.
*/
namespace ns3 {
/**

View File

@@ -20,6 +20,12 @@
#include "object-ptr-container.h"
#include "log.h"
/**
* \file
* \ingroup attribute_ObjectPtrContainer
* ObjectPtrContainer attribute value implementation.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("ObjectPtrContainer");

View File

@@ -25,6 +25,13 @@
#include "ptr.h"
#include "attribute.h"
/**
* \file
* \ingroup attribute_ObjectPtrContainer
* ObjectPtrContainer attribute value declarations and template implementations.
*/
namespace ns3 {
/**

View File

@@ -25,6 +25,12 @@
#include "attribute.h"
#include "object-ptr-container.h"
/**
* \file
* \ingroup attribute_ObjectVector
* ObjectVector attribute value declarations and template implementations.
*/
namespace ns3 {
/**

View File

@@ -22,6 +22,12 @@
#include "log.h"
#include <sstream>
/**
* \file
* \ingroup attribute_Pointer
* Pointer attribute value implementations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Pointer");

View File

@@ -23,6 +23,12 @@
#include "attribute.h"
#include "object.h"
/**
* \file
* \ingroup attribute_Pointer
* Pointer attribute value declarations and template implementations.
*/
namespace ns3 {
// Additional docs for class PointerValue:
@@ -99,9 +105,14 @@ Ptr<AttributeChecker> MakePointerChecker (void);
} // namespace ns3
namespace ns3 {
/***************************************************************
* Implementation of the templates declared above.
***************************************************************/
namespace ns3 {
namespace internal {
/** PointerChecker implementation. */

View File

@@ -19,6 +19,12 @@
#include "string.h"
/**
* \file
* \ingroup attribute_String
* String attribute value implementations.
*/
namespace ns3 {
ATTRIBUTE_CHECKER_IMPLEMENT_WITH_NAME (String, "std::string");

View File

@@ -23,9 +23,15 @@
#include <string>
#include "attribute-helper.h"
/**
* \file
* \ingroup attribute_String
* String attribute value declarations.
*/
namespace ns3 {
// Additional docs for class DoubleValue:
// Additional docs for class StringValue:
/**
* Hold variables of type string
*

View File

@@ -19,6 +19,12 @@
#include "type-name.h"
/**
* \file
* \ingroup attributeimpl
* ns3::TypeNameGet() function implementations.
*/
namespace ns3 {
template <> std::string TypeNameGet< int8_t > (void) { return "int8_t" ; }

View File

@@ -23,6 +23,12 @@
#include <stdint.h>
#include <string>
/**
* \file
* \ingroup attributeimpl
* ns3::TypeNameGet() function declarations.
*/
namespace ns3 {
/**

View File

@@ -22,6 +22,12 @@
#include "log.h"
#include <sstream>
/**
* \file
* \ingroup attribute_Uinteger
* Uinteger attribute value implementations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Uinteger");
@@ -30,6 +36,15 @@ ATTRIBUTE_VALUE_IMPLEMENT_WITH_NAME (uint64_t,Uinteger);
namespace internal {
/**
* \ingroup attribute_Uinteger
* Make an Uinteger attribute checker with embedded numeric type name.
*
* \param min The minimum allowed value.
* \param max The maximum allowed value.
* \param name The original type name ("uint8_t", "uint16_t", _etc_.).
* \returns The AttributeChecker.
*/
Ptr<const AttributeChecker> MakeUintegerChecker (uint64_t min, uint64_t max, std::string name)
{
NS_LOG_FUNCTION (min << max << name);

View File

@@ -25,9 +25,15 @@
#include <stdint.h>
#include <limits>
/**
* \file
* \ingroup attribute_Uinteger
* Unsigned integer attribute value declarations and template implementations.
*/
namespace ns3 {
// Additional docs for class DoubleValue:
// Additional docs for class UintegerValue:
/**
* Hold an unsigned integer type.
*
@@ -69,6 +75,11 @@ Ptr<const AttributeChecker> MakeUintegerChecker (uint64_t min, uint64_t max);
} // namespace ns3
/***************************************************************
* Implementation of the templates declared above.
***************************************************************/
#include "type-name.h"
namespace ns3 {

View File

@@ -23,6 +23,12 @@
#include <cmath>
#include <sstream>
/**
* \file
* \ingroup attribute_Vector
* ns3::Vector, ns3::Vector2D and ns3::Vector3D attribute value implementations.
*/
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Vector");

View File

@@ -23,6 +23,12 @@
#include "attribute.h"
#include "attribute-helper.h"
/**
* \file
* \ingroup attribute_Vector
* ns3::Vector, ns3::Vector2D and ns3::Vector3D attribute value declarations.
*/
namespace ns3 {
/**