--- a/src/core/attribute.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/core/attribute.h Tue Dec 09 20:29:04 2008 -0800
@@ -144,7 +144,7 @@
* 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
{
--- a/src/core/type-id.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/core/type-id.h Tue Dec 09 20:29:04 2008 -0800
@@ -44,23 +44,14 @@
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 */
};
/**
--- a/src/helper/application-container.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/helper/application-container.h Tue Dec 09 20:29:04 2008 -0800
@@ -41,7 +41,7 @@
/**
* 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);
--- a/src/helper/on-off-helper.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/helper/on-off-helper.h Tue Dec 09 20:29:04 2008 -0800
@@ -59,18 +59,27 @@
*
* \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;
--- a/src/internet-stack/ipv4-l4-protocol.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/internet-stack/ipv4-l4-protocol.h Tue Dec 09 20:29:04 2008 -0800
@@ -72,7 +72,7 @@
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
--- a/src/internet-stack/udp-l4-protocol.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/internet-stack/udp-l4-protocol.h Tue Dec 09 20:29:04 2008 -0800
@@ -87,8 +87,19 @@
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,
--- a/src/node/socket.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/node/socket.h Tue Dec 09 20:29:04 2008 -0800
@@ -214,7 +214,6 @@
/**
* \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;
--- a/src/routing/olsr/olsr-routing-table.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/routing/olsr/olsr-routing-table.h Tue Dec 09 20:29:04 2008 -0800
@@ -21,7 +21,7 @@
*/
///
-/// \file OLSR_rtable.h
+/// \file olsr-routing-table.h
/// \brief Header file for routing table's related stuff.
///
--- a/src/simulator/scheduler.h Tue Dec 09 12:24:24 2008 -0800
+++ b/src/simulator/scheduler.h Tue Dec 09 20:29:04 2008 -0800
@@ -87,7 +87,7 @@
*/
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.
*/