diff --git a/doc/doxygen.conf b/doc/doxygen.conf index 457007546..0380ff22b 100644 --- a/doc/doxygen.conf +++ b/doc/doxygen.conf @@ -195,6 +195,9 @@ TAB_SIZE = 4 ALIASES = +# Link to bug tracker +ALIASES += bugid{1}="Bug \1" + # Set off \internal docs ALIASES += internal="\par \b Internal:" @@ -202,8 +205,8 @@ ALIASES += internal="\par \b Internal:" # Usage: /** \param [in/out] tag If found, \pname{tag} is ... */ ALIASES += pname{1}="\1" -# Link to bug tracker -ALIASES += bugid{1}="Bug \1" +# Link to RFC's +ALIASES += RFC{1}="RFC \1" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding diff --git a/src/applications/model/radvd-prefix.h b/src/applications/model/radvd-prefix.h index 31d731b73..aa3384543 100644 --- a/src/applications/model/radvd-prefix.h +++ b/src/applications/model/radvd-prefix.h @@ -165,7 +165,7 @@ private: bool m_onLinkFlag; /** - * \brief Autonomous flag, it is used for autonomous address configuration (RFC 2462). + * \brief Autonomous flag, it is used for autonomous address configuration (\RFC{2462}). */ bool m_autonomousFlag; diff --git a/src/csma/model/csma-net-device.h b/src/csma/model/csma-net-device.h index 4a6223a8a..6d84d0f21 100644 --- a/src/csma/model/csma-net-device.h +++ b/src/csma/model/csma-net-device.h @@ -225,7 +225,7 @@ public: * \brief Make and return a MAC multicast address using the provided * multicast group * - * RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet + * \RFC{1112} says that an Ipv4 host group address is mapped to an Ethernet * multicast address by placing the low-order 23-bits of the IP address into * the low-order 23 bits of the Ethernet multicast address * 01-00-5E-00-00-00 (hex). diff --git a/src/emu/model/emu-net-device.h b/src/emu/model/emu-net-device.h index 516b92793..c4e00c7a3 100644 --- a/src/emu/model/emu-net-device.h +++ b/src/emu/model/emu-net-device.h @@ -146,7 +146,7 @@ public: * \brief Make and return a MAC multicast address using the provided * multicast group * - * RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet + * \RFC{1112} says that an Ipv4 host group address is mapped to an Ethernet * multicast address by placing the low-order 23-bits of the IP address into * the low-order 23 bits of the Ethernet multicast address * 01-00-5E-00-00-00 (hex). diff --git a/src/flow-monitor/model/flow-monitor.h b/src/flow-monitor/model/flow-monitor.h index 72a6a9bb1..a1fcb2d79 100644 --- a/src/flow-monitor/model/flow-monitor.h +++ b/src/flow-monitor/model/flow-monitor.h @@ -74,7 +74,7 @@ public: /// relatively to the last packet of the stream, /// i.e. \f$Jitter\left\{P_N\right\} = \left|Delay\left\{P_N\right\} - Delay\left\{P_{N-1}\right\}\right|\f$. /// This definition is in accordance with the Type-P-One-way-ipdv - /// as defined in IETF RFC 3393. + /// as defined in IETF \RFC{3393}. Time jitterSum; // jitterCount == rxPackets - 1 Time lastDelay; diff --git a/src/internet/helper/ipv6-address-helper.h b/src/internet/helper/ipv6-address-helper.h index 14f4de439..f1e4e56e3 100644 --- a/src/internet/helper/ipv6-address-helper.h +++ b/src/internet/helper/ipv6-address-helper.h @@ -35,7 +35,7 @@ namespace ns3 { * \class Ipv6AddressHelper * \brief Helper class to auto-assign global IPv6 unicast addresses * - * Assign global unicast IPv6 addresses based on RFC 4291 definition. + * Assign global unicast IPv6 addresses based on \RFC{4291} definition. * * | n bits | 64-n bits | 64 bits | * +-------------------------+-----------+----------------------------+ @@ -63,16 +63,16 @@ namespace ns3 { * that causes the subnet ID to roll over will trigger an assertion. * * By default, the prefix is 32 bits and the network is '2001:db8::/32' - * (RFC 5156 section 2.6 Documentation prefix). The prefix may range + * (\RFC{5156} section 2.6 Documentation prefix). The prefix may range * from length 0 to 64, with the value 64 having a special meaning that * no subnet ID boundary is enforced (equivalent to value 0). * - * There are two variants of interface ID supported (RFC 4291, Sec. 2.5.1) + * There are two variants of interface ID supported (\RFC{4291}, Sec. 2.5.1) * The default is a "local" scope, but a "universal" scoped ID may be * formed by calling "NewAddress (Address addr)" with a 48-bit MAC address. * If this method is called, the addressed returned will include a * modified EUI-64-format identifier created from the MAC address as - * specified in RFC 4291. + * specified in \RFC{4291}. */ class Ipv6AddressHelper { diff --git a/src/internet/model/global-route-manager-impl.h b/src/internet/model/global-route-manager-impl.h index 3ba9a026d..f372e9210 100644 --- a/src/internet/model/global-route-manager-impl.h +++ b/src/internet/model/global-route-manager-impl.h @@ -40,7 +40,7 @@ class CandidateQueue; class Ipv4GlobalRouting; /** - * @brief Vertex used in shortest path first (SPF) computations. See RFC 2328, + * @brief Vertex used in shortest path first (SPF) computations. See \RFC{2328}, * Section 16. * * Each router in the simulation is associated with an SPFVertex object. When @@ -695,7 +695,7 @@ private: * Then, it can compute shortest paths on a per-node basis to all routers, * and finally configure each of the node's forwarding tables. * - * The design is guided by OSPFv2 RFC 2328 section 16.1.1 and quagga ospfd. + * The design is guided by OSPFv2 \RFC{2328} section 16.1.1 and quagga ospfd. */ class GlobalRouteManagerImpl { diff --git a/src/internet/model/global-route-manager.h b/src/internet/model/global-route-manager.h index aab837285..0c913cb87 100644 --- a/src/internet/model/global-route-manager.h +++ b/src/internet/model/global-route-manager.h @@ -35,7 +35,7 @@ namespace ns3 { * Then, it can compute shortest paths on a per-node basis to all routers, * and finally configure each of the node's forwarding tables. * - * The design is guided by OSPFv2 RFC 2328 section 16.1.1 and quagga ospfd. + * The design is guided by OSPFv2 \RFC{2328} section 16.1.1 and quagga ospfd. */ class GlobalRouteManager { diff --git a/src/internet/model/global-router-interface.h b/src/internet/model/global-router-interface.h index cad0b37c3..5143a86dd 100644 --- a/src/internet/model/global-router-interface.h +++ b/src/internet/model/global-router-interface.h @@ -246,14 +246,14 @@ private: * * Roughly equivalent to a global incarnation of the OSPF link state header * combined with a list of Link Records. Since it's global, there's - * no need for age or sequence number. See RFC 2328, Appendix A. + * no need for age or sequence number. See \RFC{2328}, Appendix A. */ class GlobalRoutingLSA { public: /** * @enum LSType - * @brief corresponds to LS type field of RFC 2328 OSPF LSA header + * @brief corresponds to LS type field of \RFC{2328} OSPF LSA header */ enum LSType { Unknown = 0, /**< Uninitialized Type */ diff --git a/src/internet/model/global-routing.h b/src/internet/model/global-routing.h index 8ea92155f..52bcc6faa 100644 --- a/src/internet/model/global-routing.h +++ b/src/internet/model/global-routing.h @@ -73,7 +73,7 @@ * concerning the links to which it is attached. * * The format of the data exported conforms to the OSPFv2 standard - * (http://www.ietf.org/rfc/rfc2328.txt). In particular, the + * \RFC{2328}. In particular, the * information is exported in the form of ns3::GlobalLSA objects that * semantically match the Link State Advertisements of OSPF. * diff --git a/src/internet/model/ipv4-global-routing.cc b/src/internet/model/ipv4-global-routing.cc index 5c9e5001c..e7d7b80c7 100644 --- a/src/internet/model/ipv4-global-routing.cc +++ b/src/internet/model/ipv4-global-routing.cc @@ -493,7 +493,7 @@ Ipv4GlobalRouting::RouteInput (Ptr p, const Ipv4Header &header, P /// \todo Forward broadcast } - /// \todo Configurable option to enable RFC 1222 Strong End System Model + /// \todo Configurable option to enable \RFC{1222} Strong End System Model // Right now, we will be permissive and allow a source to send us // a packet to one of our other interface addresses; that is, the // destination unicast address does not match one of the iif addresses, diff --git a/src/internet/model/ipv4-header.h b/src/internet/model/ipv4-header.h index 9da8ee2c3..59231ce50 100644 --- a/src/internet/model/ipv4-header.h +++ b/src/internet/model/ipv4-header.h @@ -57,9 +57,9 @@ public: * \enum DscpType * \brief DiffServ Code Points * Code Points defined in - * Assured Forwarding (AF) RFC 2597 - * Expedited Forwarding (EF) RFC 2598 - * Default and Class Selector (CS) RFC 2474 + * Assured Forwarding (AF) \RFC{2597} + * Expedited Forwarding (EF) \RFC{2598} + * Default and Class Selector (CS) \RFC{2474} */ enum DscpType { @@ -100,7 +100,7 @@ public: /** * \enum EcnType - * \brief ECN Type defined in RFC 3168 + * \brief ECN Type defined in \RFC{3168} */ enum EcnType { diff --git a/src/internet/model/ipv4-static-routing.cc b/src/internet/model/ipv4-static-routing.cc index d5079c54c..15e648905 100644 --- a/src/internet/model/ipv4-static-routing.cc +++ b/src/internet/model/ipv4-static-routing.cc @@ -521,7 +521,7 @@ Ipv4StaticRouting::RouteInput (Ptr p, const Ipv4Header &ipHeader, } NS_LOG_LOGIC ("Unicast destination"); - /// \todo Configurable option to enable RFC 1222 Strong End System Model + /// \todo Configurable option to enable \RFC{1222} Strong End System Model // Right now, we will be permissive and allow a source to send us // a packet to one of our other interface addresses; that is, the // destination unicast address does not match one of the iif addresses, diff --git a/src/internet/model/ipv6-address-generator.h b/src/internet/model/ipv6-address-generator.h index 0b23b28b1..5695cd7a2 100644 --- a/src/internet/model/ipv6-address-generator.h +++ b/src/internet/model/ipv6-address-generator.h @@ -31,7 +31,7 @@ namespace ns3 { * network address; used in topology code. It also keeps track of all * addresses assigned to perform duplicate detection. * - * Global unicast IPv6 addresses based on RFC 4291 definition: + * Global unicast IPv6 addresses based on \RFC{4291} definition: * * | n bits | m bits | 128-n-m bits | * +-------------------------+-----------+----------------------------+ @@ -48,7 +48,7 @@ namespace ns3 { * the subnet ID. * * The interface ID is often an EUI-64 address derived from the MAC address, - * but can also be a pseudo-random value (RFC 3041). This implementation + * but can also be a pseudo-random value (\RFC{3041}). This implementation * does not generate EUI-64-based interface IDs. */ class Ipv6AddressGenerator diff --git a/src/internet/model/ipv6-l3-protocol.cc b/src/internet/model/ipv6-l3-protocol.cc index 7ac57c146..6d073fd1e 100644 --- a/src/internet/model/ipv6-l3-protocol.cc +++ b/src/internet/model/ipv6-l3-protocol.cc @@ -44,7 +44,7 @@ #include "icmpv6-l4-protocol.h" #include "ndisc-cache.h" -// Minimum IPv6 MTU, as defined by RFC 2460 +/// Minimum IPv6 MTU, as defined by \RFC{2460} #define IPV6_MIN_MTU 1280 namespace ns3 { diff --git a/src/internet/model/ipv6-list-routing.cc b/src/internet/model/ipv6-list-routing.cc index 086ea90de..89a0e69bb 100644 --- a/src/internet/model/ipv6-list-routing.cc +++ b/src/internet/model/ipv6-list-routing.cc @@ -147,7 +147,7 @@ Ipv6ListRouting::RouteInput (Ptr p, const Ipv6Header &header, Ptr< return retVal; } - /// \todo Configurable option to enable RFC 1222 Strong End System Model + /// \todo Configurable option to enable \RFC{1222} Strong End System Model // Right now, we will be permissive and allow a source to send us // a packet to one of our other interface addresses; that is, the // destination unicast address does not match one of the iif addresses, diff --git a/src/internet/model/ipv6-option-header.h b/src/internet/model/ipv6-option-header.h index a180cff59..0ff3470c3 100644 --- a/src/internet/model/ipv6-option-header.h +++ b/src/internet/model/ipv6-option-header.h @@ -40,7 +40,7 @@ public: * \struct Alignment * \brief represents the alignment requirements of an option header * - * Represented as factor*n+offset (eg. 8n+2) See RFC 2460. + * Represented as factor*n+offset (eg. 8n+2) See \RFC{2460}. * No alignment is represented as 1n+0. */ struct Alignment diff --git a/src/internet/model/ipv6-packet-info-tag.h b/src/internet/model/ipv6-packet-info-tag.h index 821c0029b..943e72280 100644 --- a/src/internet/model/ipv6-packet-info-tag.h +++ b/src/internet/model/ipv6-packet-info-tag.h @@ -33,8 +33,7 @@ class Packet; /** * \brief This class implements a tag that carries socket ancillary * data to the socket interface. This is used like - * socket option of IP_PKTINFO/IPV6_PKTINFO in RFC 3542 - * See: http://tools.ietf.org/html/rfc3542 + * socket option of IP_PKTINFO/IPV6_PKTINFO in \RFC{3542} * * This tag in the send direction is presently not enabled but we * would accept a patch along those lines in the future. To include diff --git a/src/internet/model/ipv6-pmtu-cache.h b/src/internet/model/ipv6-pmtu-cache.h index b8ce18f09..be78bbc2c 100644 --- a/src/internet/model/ipv6-pmtu-cache.h +++ b/src/internet/model/ipv6-pmtu-cache.h @@ -33,7 +33,7 @@ namespace ns3 { /** * \ingroup ipv6 - * \brief This class implements the Path MTU cache, as defined by RFC 1981. + * \brief This class implements the Path MTU cache, as defined by \RFC{1981}. * * The Path MTU is stored according to the destination address, and it is * cleared upon expiration (default validity time is 10 minutes). diff --git a/src/internet/model/ipv6-static-routing.cc b/src/internet/model/ipv6-static-routing.cc index e3cdaa562..9a6b98576 100644 --- a/src/internet/model/ipv6-static-routing.cc +++ b/src/internet/model/ipv6-static-routing.cc @@ -575,7 +575,7 @@ bool Ipv6StaticRouting::RouteInput (Ptr p, const Ipv6Header &heade } } - /// \todo Configurable option to enable RFC 1222 Strong End System Model + /// \todo Configurable option to enable \RFC{1222} Strong End System Model // Right now, we will be permissive and allow a source to send us // a packet to one of our other interface addresses; that is, the // destination unicast address does not match one of the iif addresses, diff --git a/src/internet/model/tcp-newreno.h b/src/internet/model/tcp-newreno.h index 18be4c44b..c09b668dd 100644 --- a/src/internet/model/tcp-newreno.h +++ b/src/internet/model/tcp-newreno.h @@ -31,7 +31,7 @@ namespace ns3 { * * \brief An implementation of a stream socket using TCP. * - * This class contains the NewReno implementation of TCP, as of RFC2582. + * This class contains the NewReno implementation of TCP, as of \RFC{2582}. */ class TcpNewReno : public TcpSocketBase { diff --git a/src/internet/model/tcp-reno.h b/src/internet/model/tcp-reno.h index 768bc9c0a..17682e35c 100644 --- a/src/internet/model/tcp-reno.h +++ b/src/internet/model/tcp-reno.h @@ -31,7 +31,7 @@ namespace ns3 { * * \brief An implementation of a stream socket using TCP. * - * This class contains the Reno implementation of TCP, according to RFC2581, + * This class contains the Reno implementation of TCP, according to \RFC{2581}, * except sec.4.1 "re-starting idle connections", which we do not detect for * idleness and thus no slow start upon resumption. */ diff --git a/src/internet/model/tcp-rfc793.h b/src/internet/model/tcp-rfc793.h index 516f6d161..dc2fd92dd 100644 --- a/src/internet/model/tcp-rfc793.h +++ b/src/internet/model/tcp-rfc793.h @@ -31,7 +31,7 @@ namespace ns3 { * * \brief An implementation of a stream socket using TCP. * - * This class contains an RFC793 implementation of TCP, as well as a sockets + * This class contains an \RFC{793} implementation of TCP, as well as a sockets * interface for talking to TCP. This serves as a base for other TCP functions * where the sliding window mechanism is handled here. This class provides * connection orientation and sliding window flow control. diff --git a/src/internet/model/tcp-tahoe.h b/src/internet/model/tcp-tahoe.h index dd18d090a..a54a80616 100644 --- a/src/internet/model/tcp-tahoe.h +++ b/src/internet/model/tcp-tahoe.h @@ -37,7 +37,7 @@ namespace ns3 { * http://inst.eecs.berkeley.edu/~ee122/fa05/projects/Project2/proj2_spec_files/sacks.pdf * In summary, we have slow start, congestion avoidance, and fast retransmit. * The implementation of these algorithms are based on W. R. Stevens's book and - * also RFC2001. + * also \RFC{2001}. */ class TcpTahoe : public TcpSocketBase { diff --git a/src/internet/model/udp-socket-factory-impl.h b/src/internet/model/udp-socket-factory-impl.h index 998b42f62..6ac8fbdcc 100644 --- a/src/internet/model/udp-socket-factory-impl.h +++ b/src/internet/model/udp-socket-factory-impl.h @@ -32,7 +32,7 @@ class UdpL4Protocol; * \defgroup udp Udp * * This is an implementation of the User Datagram Protocol described in - * RFC 768. It implements a connectionless, unreliable datagram packet + * \RFC{768}. It implements a connectionless, unreliable datagram packet * service. Packets may be reordered or duplicated before they arrive. * UDP generates and checks checksums to catch transmission errors. * diff --git a/src/network/helper/delay-jitter-estimation.h b/src/network/helper/delay-jitter-estimation.h index 32539241b..2fd942745 100644 --- a/src/network/helper/delay-jitter-estimation.h +++ b/src/network/helper/delay-jitter-estimation.h @@ -61,7 +61,7 @@ public: */ Time GetLastDelay (void) const; /** - * The jitter is calculated using the RFC 1889 (RTP) jitter + * The jitter is calculated using the \RFC{1889} (RTP) jitter * definition. * * \returns the updated jitter. diff --git a/src/network/model/net-device.h b/src/network/model/net-device.h index b259a1603..9ea0a3304 100644 --- a/src/network/model/net-device.h +++ b/src/network/model/net-device.h @@ -158,7 +158,7 @@ public: * \brief Make and return a MAC multicast address using the provided * multicast group * - * RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet + * \RFC{1112} says that an Ipv4 host group address is mapped to an Ethernet * multicast address by placing the low-order 23-bits of the IP address into * the low-order 23 bits of the Ethernet multicast address * 01-00-5E-00-00-00 (hex). Similar RFCs exist for Ipv6 and Eui64 mappings. diff --git a/src/network/utils/packetbb.h b/src/network/utils/packetbb.h index 64275b588..dc244b989 100644 --- a/src/network/utils/packetbb.h +++ b/src/network/utils/packetbb.h @@ -359,7 +359,7 @@ private: * A PacketBB packet is made up of zero or more packet TLVs (PbbTlv), and zero * or more messages (PbbMessage). * - * See: http://tools.ietf.org/html/rfc5444 for details. + * See: \RFC{5444} for details. */ class PbbPacket : public SimpleRefCount { diff --git a/src/olsr/model/olsr-routing-protocol.cc b/src/olsr/model/olsr-routing-protocol.cc index bf780f5e1..532553b7b 100644 --- a/src/olsr/model/olsr-routing-protocol.cc +++ b/src/olsr/model/olsr-routing-protocol.cc @@ -356,7 +356,7 @@ void RoutingProtocol::SetInterfaceExclusions (std::set exceptions) } // -// \brief Processes an incoming %OLSR packet following RFC 3626 specification. +// \brief Processes an incoming %OLSR packet following \RFC{3626} specification. void RoutingProtocol::RecvOlsr (Ptr socket) { @@ -506,7 +506,7 @@ RoutingProtocol::RecvOlsr (Ptr socket) } /// -/// \brief This auxiliary function (defined in RFC 3626) is used for calculating the MPR Set. +/// \brief This auxiliary function (defined in \RFC{3626}) is used for calculating the MPR Set. /// /// \param tuple the neighbor tuple which has the main address of the node we are going to calculate its degree to. /// \return the degree of the node. @@ -562,7 +562,7 @@ CoverTwoHopNeighbors (Ipv4Address neighborMainAddr, TwoHopNeighborSet & N2) } // anonymous namespace /// -/// \brief Computates MPR set of a node following RFC 3626 hints. +/// \brief Computates MPR set of a node following \RFC{3626} hints. /// void RoutingProtocol::MprComputation () @@ -870,7 +870,7 @@ RoutingProtocol::GetMainAddress (Ipv4Address iface_addr) const } /// -/// \brief Creates the routing table of the node following RFC 3626 hints. +/// \brief Creates the routing table of the node following \RFC{3626} hints. /// void RoutingProtocol::RoutingTableComputation () @@ -1188,7 +1188,7 @@ RoutingProtocol::RoutingTableComputation () /// -/// \brief Processes a HELLO message following RFC 3626 specification. +/// \brief Processes a HELLO message following \RFC{3626} specification. /// /// Link sensing and population of the Neighbor Set, 2-hop Neighbor Set and MPR /// Selector Set are performed. @@ -1252,7 +1252,7 @@ RoutingProtocol::ProcessHello (const olsr::MessageHeader &msg, } /// -/// \brief Processes a TC message following RFC 3626 specification. +/// \brief Processes a TC message following \RFC{3626} specification. /// /// The Topology Set is updated (if needed) with the information of /// the received TC message. @@ -1347,7 +1347,7 @@ RoutingProtocol::ProcessTc (const olsr::MessageHeader &msg, } /// -/// \brief Processes a MID message following RFC 3626 specification. +/// \brief Processes a MID message following \RFC{3626} specification. /// /// The Interface Association Set is updated (if needed) with the information /// of the received MID message. @@ -1426,7 +1426,7 @@ RoutingProtocol::ProcessMid (const olsr::MessageHeader &msg, } /// -/// \brief Processes a HNA message following RFC 3626 specification. +/// \brief Processes a HNA message following \RFC{3626} specification. /// /// The Host Network Association Set is updated (if needed) with the information /// of the received HNA message. @@ -1494,7 +1494,7 @@ RoutingProtocol::ProcessHna (const olsr::MessageHeader &msg, /// /// \brief OLSR's default forwarding algorithm. /// -/// See RFC 3626 for details. +/// See \RFC{3626} for details. /// /// \param p the %OLSR packet which has been received. /// \param msg the %OLSR message which must be forwarded. @@ -1982,7 +1982,7 @@ RoutingProtocol::UsesNonOlsrOutgoingInterface (const Ipv4RoutingTableEntry &rout /// /// \brief Updates Link Set according to a new received HELLO message -/// (following RFC 3626 specification). Neighbor Set is also updated if needed. +/// (following \RFC{3626} specification). Neighbor Set is also updated if needed. void RoutingProtocol::LinkSensing (const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello, @@ -2119,7 +2119,7 @@ RoutingProtocol::LinkSensing (const olsr::MessageHeader &msg, /// /// \brief Updates the Neighbor Set according to the information contained in -/// a new received HELLO message (following RFC 3626). +/// a new received HELLO message (following \RFC{3626}). void RoutingProtocol::PopulateNeighborSet (const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello) @@ -2134,7 +2134,7 @@ RoutingProtocol::PopulateNeighborSet (const olsr::MessageHeader &msg, /// /// \brief Updates the 2-hop Neighbor Set according to the information contained -/// in a new received HELLO message (following RFC 3626). +/// in a new received HELLO message (following \RFC{3626}). void RoutingProtocol::PopulateTwoHopNeighborSet (const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello) @@ -2246,7 +2246,7 @@ RoutingProtocol::PopulateTwoHopNeighborSet (const olsr::MessageHeader &msg, /// /// \brief Updates the MPR Selector Set according to the information contained in -/// a new received HELLO message (following RFC 3626). +/// a new received HELLO message (following \RFC{3626}). void RoutingProtocol::PopulateMprSelectorSet (const olsr::MessageHeader &msg, const olsr::MessageHeader::Hello &hello) diff --git a/src/olsr/model/olsr-state.h b/src/olsr/model/olsr-state.h index ca6abae0c..cb0ca55dd 100644 --- a/src/olsr/model/olsr-state.h +++ b/src/olsr/model/olsr-state.h @@ -37,15 +37,15 @@ class OlsrState // friend class Olsr; protected: - LinkSet m_linkSet; ///< Link Set (RFC 3626, section 4.2.1). - NeighborSet m_neighborSet; ///< Neighbor Set (RFC 3626, section 4.3.1). - TwoHopNeighborSet m_twoHopNeighborSet; ///< 2-hop Neighbor Set (RFC 3626, section 4.3.2). - TopologySet m_topologySet; ///< Topology Set (RFC 3626, section 4.4). - MprSet m_mprSet; ///< MPR Set (RFC 3626, section 4.3.3). - MprSelectorSet m_mprSelectorSet; ///< MPR Selector Set (RFC 3626, section 4.3.4). - DuplicateSet m_duplicateSet; ///< Duplicate Set (RFC 3626, section 3.4). - IfaceAssocSet m_ifaceAssocSet; ///< Interface Association Set (RFC 3626, section 4.1). - AssociationSet m_associationSet; ///< Association Set (RFC 3626, section12.2). Associations obtained from HNA messages generated by other nodes. + LinkSet m_linkSet; ///< Link Set (\RFC{3626}, section 4.2.1). + NeighborSet m_neighborSet; ///< Neighbor Set (\RFC{3626}, section 4.3.1). + TwoHopNeighborSet m_twoHopNeighborSet; ///< 2-hop Neighbor Set (\RFC{3626}, section 4.3.2). + TopologySet m_topologySet; ///< Topology Set (\RFC{3626}, section 4.4). + MprSet m_mprSet; ///< MPR Set (\RFC{3626}, section 4.3.3). + MprSelectorSet m_mprSelectorSet; ///< MPR Selector Set (\RFC{3626}, section 4.3.4). + DuplicateSet m_duplicateSet; ///< Duplicate Set (\RFC{3626}, section 3.4). + IfaceAssocSet m_ifaceAssocSet; ///< Interface Association Set (\RFC{3626}, section 4.1). + AssociationSet m_associationSet; ///< Association Set (\RFC{3626}, section12.2). Associations obtained from HNA messages generated by other nodes. Associations m_associations; ///< The node's local Host Network Associations that will be advertised using HNA messages. public: diff --git a/src/point-to-point/model/ppp-header.h b/src/point-to-point/model/ppp-header.h index e1c298ffe..c88129696 100644 --- a/src/point-to-point/model/ppp-header.h +++ b/src/point-to-point/model/ppp-header.h @@ -28,7 +28,7 @@ namespace ns3 { * \brief Packet header for PPP * * This class can be used to add a header to PPP packet. Currently we do not - * implement any of the state machine in RFC 1661, we just encapsulate the + * implement any of the state machine in \RFC{1661}, we just encapsulate the * inbound packet send it on. The goal here is not really to implement the * point-to-point protocol, but to encapsulate our packets in a known protocol * so packet sniffers can parse them. @@ -69,7 +69,7 @@ public: /** * \brief Set the protocol type carried by this PPP packet * - * The type numbers to be used are defined in RFC3818 + * The type numbers to be used are defined in \RFC{3818} * * \param protocol the protocol type being carried */ @@ -78,7 +78,7 @@ public: /** * \brief Get the protocol type carried by this PPP packet * - * The type numbers to be used are defined in RFC3818 + * The type numbers to be used are defined in \RFC{3818} * * \return the protocol type being carried */