make a pass through doxygen fixing errors ns-3.3-RC3
authorCraig Dowell <craigdo@ee.washington.edu>
Tue, 09 Dec 2008 20:29:04 -0800
changeset 3997a66553c56a8f
parent 3996 2277ff80158c
child 3998 59f227f48259
make a pass through doxygen fixing errors
src/core/attribute.h
src/core/type-id.h
src/helper/application-container.h
src/helper/on-off-helper.h
src/internet-stack/ipv4-l4-protocol.h
src/internet-stack/udp-l4-protocol.h
src/node/socket.h
src/routing/olsr/olsr-routing-table.h
src/simulator/scheduler.h
     1.1 --- a/src/core/attribute.h	Tue Dec 09 12:24:24 2008 -0800
     1.2 +++ b/src/core/attribute.h	Tue Dec 09 20:29:04 2008 -0800
     1.3 @@ -144,7 +144,7 @@
     1.4   * to detect the type of the associated attribute.
     1.5   *
     1.6   * Most subclasses of this base class are implemented by the 
     1.7 - * \ref ATTRIBUTE_HELPER_HEADER and \ref ATTRIBUTE_HELPER_CPP macros.
     1.8 + * ATTRIBUTE_HELPER_HEADER and ATTRIBUTE_HELPER_CPP macros.
     1.9   */
    1.10  class AttributeChecker : public RefCountBase
    1.11  {
     2.1 --- a/src/core/type-id.h	Tue Dec 09 12:24:24 2008 -0800
     2.2 +++ b/src/core/type-id.h	Tue Dec 09 20:29:04 2008 -0800
     2.3 @@ -44,23 +44,14 @@
     2.4  class TypeId
     2.5  {
     2.6  public:
     2.7 +  /**
     2.8 +   * Flags describing when a given attribute can be read or written
     2.9 +   */
    2.10    enum AttributeFlag {
    2.11 -    /**
    2.12 -     * The attribute can be read
    2.13 -     */
    2.14 -    ATTR_GET = 1<<0,
    2.15 -    /**
    2.16 -     * The attribute can be written
    2.17 -     */
    2.18 -    ATTR_SET = 1<<1,
    2.19 -    /**
    2.20 -     * The attribute can be written at construction-time.
    2.21 -     */
    2.22 -    ATTR_CONSTRUCT = 1<<2,
    2.23 -    /**
    2.24 -     * The attribute can be read, and written at any time.
    2.25 -     */
    2.26 -    ATTR_SGC = ATTR_GET | ATTR_SET | ATTR_CONSTRUCT,
    2.27 +    ATTR_GET = 1<<0, /**< The attribute can be read */
    2.28 +    ATTR_SET = 1<<1, /**< The attribute can be written */
    2.29 +    ATTR_CONSTRUCT = 1<<2, /**< The attribute can be written at construction-time */
    2.30 +    ATTR_SGC = ATTR_GET | ATTR_SET | ATTR_CONSTRUCT, /** The attribute can be read, and written at any time */
    2.31    };
    2.32  
    2.33    /**
     3.1 --- a/src/helper/application-container.h	Tue Dec 09 12:24:24 2008 -0800
     3.2 +++ b/src/helper/application-container.h	Tue Dec 09 20:29:04 2008 -0800
     3.3 @@ -41,7 +41,7 @@
     3.4    /**
     3.5     * Create an ApplicationContainer with exactly one application
     3.6     *
     3.7 -   * \param node a node to add to the container
     3.8 +   * \param application The application to add to the container
     3.9     */
    3.10    ApplicationContainer (Ptr<Application> application);
    3.11  
     4.1 --- a/src/helper/on-off-helper.h	Tue Dec 09 12:24:24 2008 -0800
     4.2 +++ b/src/helper/on-off-helper.h	Tue Dec 09 20:29:04 2008 -0800
     4.3 @@ -59,18 +59,27 @@
     4.4     *
     4.5     * \param c NodeContainer of the set of nodes on which an OnOffApplication 
     4.6     * will be installed.
     4.7 +   * \returns Container of Ptr to the applications installed.
     4.8     */
     4.9    ApplicationContainer Install (NodeContainer c) const;
    4.10  
    4.11    /**
    4.12 -   * Install an ns3::OnOffApplication on each node of the input container
    4.13 -   * configured with all the attributes set with SetAttribute.
    4.14 +   * Install an ns3::OnOffApplication on the node configured with all the 
    4.15 +   * attributes set with SetAttribute.
    4.16     *
    4.17 -   * \param c The node on which an OnOffApplication will be installed.
    4.18 +   * \param node The node on which an OnOffApplication will be installed.
    4.19 +   * \returns Container of Ptr to the applications installed.
    4.20     */
    4.21    ApplicationContainer Install (Ptr<Node> node) const;
    4.22  
    4.23  private:
    4.24 +  /**
    4.25 +   * Install an ns3::OnOffApplication on the node configured with all the 
    4.26 +   * attributes set with SetAttribute.
    4.27 +   *
    4.28 +   * \param node The node on which an OnOffApplication will be installed.
    4.29 +   * \returns Ptr to the application installed.
    4.30 +   */
    4.31    Ptr<Application> InstallPriv (Ptr<Node> node) const;
    4.32    std::string m_protocol;
    4.33    Address m_remote;
     5.1 --- a/src/internet-stack/ipv4-l4-protocol.h	Tue Dec 09 12:24:24 2008 -0800
     5.2 +++ b/src/internet-stack/ipv4-l4-protocol.h	Tue Dec 09 20:29:04 2008 -0800
     5.3 @@ -72,7 +72,7 @@
     5.4                                  Ptr<Ipv4Interface> incomingInterface) = 0;
     5.5  
     5.6    /**
     5.7 -   * \param icmpSouce the source address of the icmp message
     5.8 +   * \param icmpSource the source address of the icmp message
     5.9     * \param icmpTtl the ttl of the icmp message
    5.10     * \param icmpType the 'type' field of the icmp message
    5.11     * \param icmpCode the 'code' field of the icmp message
     6.1 --- a/src/internet-stack/udp-l4-protocol.h	Tue Dec 09 12:24:24 2008 -0800
     6.2 +++ b/src/internet-stack/udp-l4-protocol.h	Tue Dec 09 20:29:04 2008 -0800
     6.3 @@ -87,8 +87,19 @@
     6.4    virtual enum Ipv4L4Protocol::RxStatus Receive(Ptr<Packet> p, 
     6.5                                                  Ipv4Address const &source,
     6.6                                                  Ipv4Address const &destination,
     6.7 -                       Ptr<Ipv4Interface> interface);
     6.8 +                                                Ptr<Ipv4Interface> interface);
     6.9  
    6.10 +  /**
    6.11 +   * \brief Receive an ICMP packet
    6.12 +   * \param icmpSource The IP address of the source of the packet.
    6.13 +   * \param icmpTtl The time to live from the IP header
    6.14 +   * \param icmpType The type of the message from the ICMP header
    6.15 +   * \param icmpCode The message code from the ICMP header
    6.16 +   * \param icmpInfo 32-bit integer carrying informational value of varying semantics.
    6.17 +   * \param payloadSource The IP source addresss from the IP header of the packet
    6.18 +   * \param payloadDestination The IP destination address from the IP header of the packet
    6.19 +   * \param payload Payload of the ICMP packet
    6.20 +   */
    6.21    virtual void ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl,
    6.22                              uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,
    6.23                              Ipv4Address payloadSource,Ipv4Address payloadDestination,
     7.1 --- a/src/node/socket.h	Tue Dec 09 12:24:24 2008 -0800
     7.2 +++ b/src/node/socket.h	Tue Dec 09 20:29:04 2008 -0800
     7.3 @@ -214,7 +214,6 @@
     7.4      
     7.5    /**
     7.6     * \brief Listen for incoming connections.
     7.7 -   * \param queueLimit maximum number of incoming request to queue
     7.8     * \returns 0 on success, -1 on error (in which case errno is set).
     7.9     */
    7.10    virtual int Listen (void) = 0;
     8.1 --- a/src/routing/olsr/olsr-routing-table.h	Tue Dec 09 12:24:24 2008 -0800
     8.2 +++ b/src/routing/olsr/olsr-routing-table.h	Tue Dec 09 20:29:04 2008 -0800
     8.3 @@ -21,7 +21,7 @@
     8.4   */
     8.5  
     8.6  ///
     8.7 -/// \file	OLSR_rtable.h
     8.8 +/// \file	olsr-routing-table.h
     8.9  /// \brief	Header file for routing table's related stuff.
    8.10  ///
    8.11  
     9.1 --- a/src/simulator/scheduler.h	Tue Dec 09 12:24:24 2008 -0800
     9.2 +++ b/src/simulator/scheduler.h	Tue Dec 09 20:29:04 2008 -0800
     9.3 @@ -87,7 +87,7 @@
     9.4     */
     9.5    virtual Event RemoveNext (void) = 0;
     9.6    /**
     9.7 -   * \param id the id of the event to remove
     9.8 +   * \param ev the event to remove
     9.9     *
    9.10     * This methods cannot be invoked if the list is empty.
    9.11     */