make a pass through doxygen fixing errors

This commit is contained in:
Craig Dowell
2008-12-09 20:29:04 -08:00
parent 438b8e25e7
commit cea36a7ce4
9 changed files with 36 additions and 26 deletions

View File

@@ -144,7 +144,7 @@ public:
* to detect the type of the associated attribute.
*
* Most subclasses of this base class are implemented by the
* \ref ATTRIBUTE_HELPER_HEADER and \ref ATTRIBUTE_HELPER_CPP macros.
* ATTRIBUTE_HELPER_HEADER and ATTRIBUTE_HELPER_CPP macros.
*/
class AttributeChecker : public RefCountBase
{

View File

@@ -44,23 +44,14 @@ class TraceSourceAccessor;
class TypeId
{
public:
/**
* Flags describing when a given attribute can be read or written
*/
enum AttributeFlag {
/**
* The attribute can be read
*/
ATTR_GET = 1<<0,
/**
* The attribute can be written
*/
ATTR_SET = 1<<1,
/**
* The attribute can be written at construction-time.
*/
ATTR_CONSTRUCT = 1<<2,
/**
* The attribute can be read, and written at any time.
*/
ATTR_SGC = ATTR_GET | ATTR_SET | ATTR_CONSTRUCT,
ATTR_GET = 1<<0, /**< The attribute can be read */
ATTR_SET = 1<<1, /**< The attribute can be written */
ATTR_CONSTRUCT = 1<<2, /**< The attribute can be written at construction-time */
ATTR_SGC = ATTR_GET | ATTR_SET | ATTR_CONSTRUCT, /** The attribute can be read, and written at any time */
};
/**

View File

@@ -41,7 +41,7 @@ public:
/**
* Create an ApplicationContainer with exactly one application
*
* \param node a node to add to the container
* \param application The application to add to the container
*/
ApplicationContainer (Ptr<Application> application);

View File

@@ -59,18 +59,27 @@ public:
*
* \param c NodeContainer of the set of nodes on which an OnOffApplication
* will be installed.
* \returns Container of Ptr to the applications installed.
*/
ApplicationContainer Install (NodeContainer c) const;
/**
* Install an ns3::OnOffApplication on each node of the input container
* configured with all the attributes set with SetAttribute.
* Install an ns3::OnOffApplication on the node configured with all the
* attributes set with SetAttribute.
*
* \param c The node on which an OnOffApplication will be installed.
* \param node The node on which an OnOffApplication will be installed.
* \returns Container of Ptr to the applications installed.
*/
ApplicationContainer Install (Ptr<Node> node) const;
private:
/**
* Install an ns3::OnOffApplication on the node configured with all the
* attributes set with SetAttribute.
*
* \param node The node on which an OnOffApplication will be installed.
* \returns Ptr to the application installed.
*/
Ptr<Application> InstallPriv (Ptr<Node> node) const;
std::string m_protocol;
Address m_remote;

View File

@@ -72,7 +72,7 @@ public:
Ptr<Ipv4Interface> incomingInterface) = 0;
/**
* \param icmpSouce the source address of the icmp message
* \param icmpSource the source address of the icmp message
* \param icmpTtl the ttl of the icmp message
* \param icmpType the 'type' field of the icmp message
* \param icmpCode the 'code' field of the icmp message

View File

@@ -87,8 +87,19 @@ public:
virtual enum Ipv4L4Protocol::RxStatus Receive(Ptr<Packet> p,
Ipv4Address const &source,
Ipv4Address const &destination,
Ptr<Ipv4Interface> interface);
Ptr<Ipv4Interface> interface);
/**
* \brief Receive an ICMP packet
* \param icmpSource The IP address of the source of the packet.
* \param icmpTtl The time to live from the IP header
* \param icmpType The type of the message from the ICMP header
* \param icmpCode The message code from the ICMP header
* \param icmpInfo 32-bit integer carrying informational value of varying semantics.
* \param payloadSource The IP source addresss from the IP header of the packet
* \param payloadDestination The IP destination address from the IP header of the packet
* \param payload Payload of the ICMP packet
*/
virtual void ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl,
uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,
Ipv4Address payloadSource,Ipv4Address payloadDestination,

View File

@@ -214,7 +214,6 @@ public:
/**
* \brief Listen for incoming connections.
* \param queueLimit maximum number of incoming request to queue
* \returns 0 on success, -1 on error (in which case errno is set).
*/
virtual int Listen (void) = 0;

View File

@@ -21,7 +21,7 @@
*/
///
/// \file OLSR_rtable.h
/// \file olsr-routing-table.h
/// \brief Header file for routing table's related stuff.
///

View File

@@ -87,7 +87,7 @@ class Scheduler : public Object
*/
virtual Event RemoveNext (void) = 0;
/**
* \param id the id of the event to remove
* \param ev the event to remove
*
* This methods cannot be invoked if the list is empty.
*/