diff --git a/src/core/attribute.h b/src/core/attribute.h index a18f3694a..2ba5ab1f3 100644 --- a/src/core/attribute.h +++ b/src/core/attribute.h @@ -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 { diff --git a/src/core/type-id.h b/src/core/type-id.h index f6d9790bc..a131f25dc 100644 --- a/src/core/type-id.h +++ b/src/core/type-id.h @@ -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 */ }; /** diff --git a/src/helper/application-container.h b/src/helper/application-container.h index 4988500d2..6c6793480 100644 --- a/src/helper/application-container.h +++ b/src/helper/application-container.h @@ -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); diff --git a/src/helper/on-off-helper.h b/src/helper/on-off-helper.h index edac09cc2..502c404bd 100644 --- a/src/helper/on-off-helper.h +++ b/src/helper/on-off-helper.h @@ -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) 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 InstallPriv (Ptr node) const; std::string m_protocol; Address m_remote; diff --git a/src/internet-stack/ipv4-l4-protocol.h b/src/internet-stack/ipv4-l4-protocol.h index ffdc6042e..09c04c3b8 100644 --- a/src/internet-stack/ipv4-l4-protocol.h +++ b/src/internet-stack/ipv4-l4-protocol.h @@ -72,7 +72,7 @@ public: Ptr 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 diff --git a/src/internet-stack/udp-l4-protocol.h b/src/internet-stack/udp-l4-protocol.h index 55d967c67..0028be49b 100644 --- a/src/internet-stack/udp-l4-protocol.h +++ b/src/internet-stack/udp-l4-protocol.h @@ -87,8 +87,19 @@ public: virtual enum Ipv4L4Protocol::RxStatus Receive(Ptr p, Ipv4Address const &source, Ipv4Address const &destination, - Ptr interface); + Ptr 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, diff --git a/src/node/socket.h b/src/node/socket.h index 22fd59e86..caba3627b 100644 --- a/src/node/socket.h +++ b/src/node/socket.h @@ -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; diff --git a/src/routing/olsr/olsr-routing-table.h b/src/routing/olsr/olsr-routing-table.h index d76ba3287..bbd20a2bc 100644 --- a/src/routing/olsr/olsr-routing-table.h +++ b/src/routing/olsr/olsr-routing-table.h @@ -21,7 +21,7 @@ */ /// -/// \file OLSR_rtable.h +/// \file olsr-routing-table.h /// \brief Header file for routing table's related stuff. /// diff --git a/src/simulator/scheduler.h b/src/simulator/scheduler.h index 5b26392ad..72331baba 100644 --- a/src/simulator/scheduler.h +++ b/src/simulator/scheduler.h @@ -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. */