Doxygenate todo's
authorPeter D. Barnes, Jr. <barnes26@llnl.gov>
Wed, 03 Jul 2013 14:43:10 -0700
changeset 9894 ac4e52a91d5d
parent 9893 18f2d30eddbe
child 9895 7a448f745b9d
Doxygenate todo's
src/click/model/ipv4-click-routing.cc
src/click/model/ipv4-l3-click-protocol.cc
src/core/examples/main-random-variable-stream.cc
src/core/model/default-simulator-impl.cc
src/core/model/int64x64-double.h
src/core/model/random-variable.cc
src/core/model/realtime-simulator-impl.cc
src/core/model/system-path.cc
src/core/model/wall-clock-synchronizer.cc
src/core/test/random-variable-stream-test-suite.cc
src/dsr/model/dsr-routing.cc
src/fd-net-device/model/fd-net-device.cc
src/internet/helper/ipv6-address-helper.cc
src/internet/model/icmpv6-l4-protocol.cc
src/internet/model/ipv4-global-routing.cc
src/internet/model/ipv4-interface.cc
src/internet/model/ipv4-l3-protocol.cc
src/internet/model/ipv6-extension-header.cc
src/internet/model/ipv6-interface.cc
src/internet/model/ipv6-l3-protocol.cc
src/internet/model/ndisc-cache.cc
src/internet/model/nsc-tcp-l4-protocol.cc
src/internet/model/nsc-tcp-socket-impl.cc
src/internet/model/nsc-tcp-socket-impl.h
src/internet/model/pending-data.cc
src/internet/model/tcp-header.h
src/internet/model/tcp-l4-protocol.cc
src/internet/model/udp-socket-impl.cc
src/internet/test/global-route-manager-impl-test-suite.cc
src/lte/model/lte-ue-mac.cc
src/mesh/helper/mesh-helper.h
src/mpi/model/distributed-simulator-impl.cc
src/network/model/packet.cc
src/network/test/buffer-test.cc
src/olsr/model/olsr-routing-protocol.cc
src/wifi/model/aarf-wifi-manager.cc
src/wifi/model/aarfcd-wifi-manager.cc
src/wifi/model/amrr-wifi-manager.cc
src/wifi/model/arf-wifi-manager.cc
src/wifi/model/cara-wifi-manager.cc
src/wifi/model/mac-low.cc
src/wifi/model/onoe-wifi-manager.cc
src/wimax/model/bs-scheduler-simple.cc
--- a/src/click/model/ipv4-click-routing.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/click/model/ipv4-click-routing.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -506,6 +506,7 @@
         }
       else
         {
+          /** \todo Implement IP aliasing and Click */
           NS_FATAL_ERROR ("XXX Not implemented yet:  IP aliasing and Click");
         }
       rtentry->SetSource (ifAddr.GetLocal ());
--- a/src/click/model/ipv4-l3-click-protocol.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/click/model/ipv4-l3-click-protocol.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -609,9 +609,9 @@
   return index;
 }
 
-// XXX when should we set ip_id?   check whether we are incrementing
-// m_identification on packets that may later be dropped in this stack
-// and whether that deviates from Linux
+/// \todo when should we set ip_id?   check whether we are incrementing
+/// m_identification on packets that may later be dropped in this stack
+/// and whether that deviates from Linux
 Ipv4Header
 Ipv4L3ClickProtocol::BuildHeader (
   Ipv4Address source,
--- a/src/core/examples/main-random-variable-stream.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/examples/main-random-variable-stream.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -229,7 +229,7 @@
     gnuplots.AddPlot (plot);
   }
 
-  // XXX Turn this plot back on once its distribution has been finished.
+  /// \todo Turn this plot back on once its distribution has been finished.
   /*
   {
     Gnuplot plot;
@@ -249,10 +249,9 @@
 
     gnuplots.AddPlot (plot);
   }
-  // XXX Turn the above plot back on once its distribution has been finished.
   */
 
-  // XXX Turn this plot back on once its distribution has been finished.
+  /// \todo Turn this plot back on once its distribution has been finished.
   /*
   {
     Gnuplot plot;
@@ -267,7 +266,6 @@
 
     gnuplots.AddPlot (plot);
   }
-  // XXX Turn the above plot back on once its distribution has been finished.
   */
 
   {
--- a/src/core/model/default-simulator-impl.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/model/default-simulator-impl.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -393,8 +393,8 @@
 Time 
 DefaultSimulatorImpl::GetMaximumSimulationTime (void) const
 {
-  // XXX: I am fairly certain other compilers use other non-standard
-  // post-fixes to indicate 64 bit constants.
+  /// \todo I am fairly certain other compilers use other non-standard
+  /// post-fixes to indicate 64 bit constants.
   return TimeStep (0x7fffffffffffffffLL);
 }
 
--- a/src/core/model/int64x64-double.h	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/model/int64x64-double.h	Wed Jul 03 14:43:10 2013 -0700
@@ -27,7 +27,7 @@
   inline int64x64_t (unsigned long long int v)
     : _v (v) {}
   inline int64x64_t (int64_t hi, uint64_t lo)
-    : _v (hi) { /* XXX */}
+    : _v (hi) { /** \todo add in lo? */}
 
   inline int64x64_t (const int64x64_t &o)
     : _v (o._v) {}
@@ -47,7 +47,7 @@
   }
   inline uint64_t GetLow (void) const
   {
-    // XXX
+    /// \todo Generate lo?
     return 0;
   }
 
--- a/src/core/model/random-variable.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/model/random-variable.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -1700,8 +1700,8 @@
 double
 ErlangVariableImpl::GetValue (unsigned int k, double lambda)
 {
-  // XXX: Fixme: do not create a new 
-  // RNG stream every time the function is called !
+  /// \todo do not create a new 
+  /// RNG stream every time the function is called !
   NS_LOG_FUNCTION (this << k << lambda);
   ExponentialVariable exponential (lambda);
 
@@ -2039,7 +2039,7 @@
         }
       return os;
     }
-  // XXX: support other distributions
+  /// \todo support other distributions
   os.setstate (std::ios_base::badbit);
   return os;
 }
@@ -2125,7 +2125,7 @@
   else
     {
       NS_FATAL_ERROR ("RandomVariable deserialization not implemented for " << type);
-      // XXX: support other distributions.
+      /// \todo support other distributions.
     }
   return is;
 }
--- a/src/core/model/realtime-simulator-impl.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/model/realtime-simulator-impl.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -795,8 +795,8 @@
 Time 
 RealtimeSimulatorImpl::GetMaximumSimulationTime (void) const
 {
-  // XXX: I am fairly certain other compilers use other non-standard
-  // post-fixes to indicate 64 bit constants.
+  /// \todo I am fairly certain other compilers use other non-standard
+  /// post-fixes to indicate 64 bit constants.
   return TimeStep (0x7fffffffffffffffLL);
 }
 
--- a/src/core/model/system-path.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/model/system-path.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -110,8 +110,8 @@
   }
 #elif defined (__win32__)
   {
-    // XXX: untested. it should work if code is compiled with
-    // LPTSTR = char *
+    /// \todo untested. it should work if code is compiled with
+    /// LPTSTR = char *
     DWORD size = 1024;
     LPTSTR lpFilename = (LPTSTR) malloc (sizeof(TCHAR) * size);
     DWORD status = GetModuleFilename (0, lpFilename, size);
@@ -232,7 +232,7 @@
     }
   closedir (dp);
 #elif defined (HAVE_FIND_FIRST_FILE)
-  // XXX: untested
+  /// \todo untested
   HANDLE hFind;
   WIN32_FIND_DATA fileData;
   
--- a/src/core/model/wall-clock-synchronizer.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/model/wall-clock-synchronizer.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -203,7 +203,7 @@
 // I'm not really sure about this number -- a boss of mine once said, "pick
 // a number and it'll be wrong."  But this works for now.
 //
-// XXX BUGBUG Hardcoded tunable parameter below.
+// \todo Hardcoded tunable parameter below.
 //
   if (numberJiffies > 3)
     {
--- a/src/core/test/random-variable-stream-test-suite.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/core/test/random-variable-stream-test-suite.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -1597,10 +1597,10 @@
 
   // Test that values have approximately the right mean value.
   //
-  // XXX This test fails sometimes if the required tolerance is less
-  // than 3%, which may be because there is a bug in the
-  // implementation or that the mean of this distribution is more
-  // senstive to its parameters than the others are.
+  /// \todo This test fails sometimes if the required tolerance is less
+  /// than 3%, which may be because there is a bug in the
+  /// implementation or that the mean of this distribution is more
+  /// senstive to its parameters than the others are.
   double TOLERANCE = expectedMean * 3e-2;
   NS_TEST_ASSERT_MSG_EQ_TOL (valueMean, expectedMean, TOLERANCE, "Wrong mean value."); 
 }
@@ -1740,10 +1740,10 @@
 
   // Test that values have approximately the right mean value.
   //
-  // XXX This test fails sometimes if the required tolerance is less
-  // than 3%, which may be because there is a bug in the
-  // implementation or that the mean of this distribution is more
-  // senstive to its parameters than the others are.
+  /// \todo This test fails sometimes if the required tolerance is less
+  /// than 3%, which may be because there is a bug in the
+  /// implementation or that the mean of this distribution is more
+  /// senstive to its parameters than the others are.
   double TOLERANCE = expectedMean * 3e-2;
   NS_TEST_ASSERT_MSG_EQ_TOL (valueMean, expectedMean, TOLERANCE, "Wrong mean value."); 
 }
@@ -2798,16 +2798,16 @@
   AddTestCase (new RandomVariableStreamWeibullTestCase, TestCase::QUICK);
   AddTestCase (new RandomVariableStreamWeibullAntitheticTestCase, TestCase::QUICK);
   AddTestCase (new RandomVariableStreamLogNormalTestCase, TestCase::QUICK);
-  // XXX This test is currently disabled because it fails sometimes.
-  // A possible reason for the failure is that the antithetic code is
-  // not implemented properly for this log-normal case.
+  /// \todo This test is currently disabled because it fails sometimes.
+  /// A possible reason for the failure is that the antithetic code is
+  /// not implemented properly for this log-normal case.
   /*
   AddTestCase (new RandomVariableStreamLogNormalAntitheticTestCase, TestCase::QUICK);
   */
   AddTestCase (new RandomVariableStreamGammaTestCase, TestCase::QUICK);
-  // XXX This test is currently disabled because it fails sometimes.
-  // A possible reason for the failure is that the antithetic code is
-  // not implemented properly for this gamma case.
+  /// \todo This test is currently disabled because it fails sometimes.
+  /// A possible reason for the failure is that the antithetic code is
+  /// not implemented properly for this gamma case.
   /*
   AddTestCase (new RandomVariableStreamGammaAntitheticTestCase, TestCase::QUICK);
   */
--- a/src/dsr/model/dsr-routing.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/dsr/model/dsr-routing.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -1094,7 +1094,7 @@
 
                   m_downTarget (newPacket, m_mainAddress, nextHop, GetProtocolNumber (), m_ipv4Route);
 
-                  /// \todo
+                  /// \todo New DsrNetworkQueueEntry
 //                  DsrNetworkQueueEntry newEntry (newPacket, m_mainAddress, nextHop, Simulator::Now (), m_ipv4Route);
 //
 //                  if (dsrNetworkQueue->Enqueue (newEntry))
@@ -1475,7 +1475,7 @@
 
       m_downTarget (newPacket, m_mainAddress, nextHop, GetProtocolNumber (), m_ipv4Route);
 
-      /// \todo
+      /// \todo New DsrNetworkQueueEntry
 //      DsrNetworkQueueEntry newEntry (newPacket, m_mainAddress, nextHop, Simulator::Now (), m_ipv4Route);
 //
 //      if (dsrNetworkQueue->Enqueue (newEntry))
@@ -1520,7 +1520,7 @@
 
   m_downTarget (packet, m_mainAddress, nextHop, GetProtocolNumber (), route);
 
-  /// \todo
+  /// \todo New DsrNetworkQueueEntry
 //  DsrNetworkQueueEntry newEntry (packet, m_mainAddress, nextHop, Simulator::Now (), route);
 //
 //  if (dsrNetworkQueue->Enqueue (newEntry))
@@ -1732,7 +1732,7 @@
 
   m_downTarget (packet, source, nextHop, GetProtocolNumber (), m_ipv4Route);
 
-  /// \todo 
+  /// \todo New DsrNetworkQueueEntry 
 //  DsrNetworkQueueEntry newEntry (packet, source, nextHop, Simulator::Now (), m_ipv4Route);
 //
 //  if (dsrNetworkQueue->Enqueue (newEntry))
@@ -2038,7 +2038,7 @@
 
                   m_downTarget (newPacket, m_mainAddress, nextHop, GetProtocolNumber (), m_ipv4Route);
 
-                  /// \todo
+                  /// \todo New DsrNetworkQueueEntry
 //                  DsrNetworkQueueEntry newEntry (newPacket, m_mainAddress, nextHop, Simulator::Now (), m_ipv4Route);
 //
 //                  if (dsrNetworkQueue->Enqueue (newEntry))
@@ -2390,7 +2390,7 @@
 
       m_downTarget (p, m_mainAddress, nextHop, GetProtocolNumber (), m_ipv4Route);
 
-      /// \todo
+      /// \todo New DsrNetworkQueueEntry
 //      DsrNetworkQueueEntry newEntry (p, m_mainAddress, nextHop, Simulator::Now (), m_ipv4Route);
 //
 //      if (dsrNetworkQueue->Enqueue (newEntry))
@@ -3227,7 +3227,7 @@
 
   m_downTarget (packet, source, m_broadcast, GetProtocolNumber (), 0);
 
-  /// \todo
+  /// \todo New DsrNetworkQueueEntry
 //  DsrNetworkQueueEntry newEntry (packet, source, m_broadcast, Simulator::Now (), 0);
 //  if (dsrNetworkQueue->Enqueue (newEntry))
 //    {
@@ -3333,7 +3333,7 @@
 
   m_downTarget (packet, source, nextHop, GetProtocolNumber (), route);
 
-  /// \todo
+  /// \todo New DsrNetworkQueueEntry
 //  DsrNetworkQueueEntry newEntry (packet, source, nextHop, Simulator::Now (), route);
 //  if (dsrNetworkQueue->Enqueue (newEntry))
 //    {
@@ -3410,7 +3410,7 @@
 
   m_downTarget (packet, m_mainAddress, destination, GetProtocolNumber (), route);
 
-  /// \todo
+  /// \todo New DsrNetworkQueueEntry
 //  DsrNetworkQueueEntry newEntry (packet, m_mainAddress, destination, Simulator::Now (), route);
 //  if (dsrNetworkQueue->Enqueue (newEntry))
 //    {
--- a/src/fd-net-device/model/fd-net-device.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/fd-net-device/model/fd-net-device.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -284,9 +284,9 @@
    }
 }
 
-// XXX: Consider having a instance member m_packetBuffer and using memmove
-//	instead of memcpy to add the PI header.
-//      It might be faster in this case to use memmove and avoid the extra mallocs.
+/// \todo Consider having a instance member m_packetBuffer and using memmove
+///  instead of memcpy to add the PI header.
+///  It might be faster in this case to use memmove and avoid the extra mallocs.
 static void
 AddPIHeader (uint8_t *&buf, ssize_t &len)
 {
--- a/src/internet/helper/ipv6-address-helper.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/helper/ipv6-address-helper.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -51,8 +51,8 @@
                             Ipv6Address base)
 {
   NS_LOG_FUNCTION (this << network << prefix << base);
-  // XXX for now we do not enforce the prefix because the underlying
-  // Ipv6AddressGenerator does not handle prefixes well that are not 64 bits
+  /// \todo for now we do not enforce the prefix because the underlying
+  /// Ipv6AddressGenerator does not handle prefixes well that are not 64 bits
   Ipv6AddressGenerator::Init (network, Ipv6Prefix (64), base);
 }
 
--- a/src/internet/model/icmpv6-l4-protocol.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/icmpv6-l4-protocol.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -319,7 +319,7 @@
             {
               p->RemoveHeader (mtuHdr);
               hasMtu = true;
-              /* XXX case of multiple prefix on single interface */
+              /** \todo case of multiple prefix on single interface */
               /* interface->GetDevice ()->SetMtu (m.GetMtu ()); */
             }
           break;
--- a/src/internet/model/ipv4-global-routing.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/ipv4-global-routing.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -230,7 +230,7 @@
       // create a Ipv4Route object from the selected routing table entry
       rtentry = Create<Ipv4Route> ();
       rtentry->SetDestination (route->GetDest ());
-      // XXX handle multi-address case
+      /// \todo handle multi-address case
       rtentry->SetSource (m_ipv4->GetAddress (route->GetInterface (), 0).GetLocal ());
       rtentry->SetGateway (route->GetGateway ());
       uint32_t interfaceIdx = route->GetInterface ();
--- a/src/internet/model/ipv4-interface.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/ipv4-interface.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -207,8 +207,8 @@
   // Check for a loopback device
   if (DynamicCast<LoopbackNetDevice> (m_device))
     {
-      // XXX additional checks needed here (such as whether multicast
-      // goes to loopback)?
+      /// \todo additional checks needed here (such as whether multicast
+      /// goes to loopback)?
       m_device->Send (p, m_device->GetBroadcast (), 
                       Ipv4L3Protocol::PROT_NUMBER);
       return;
--- a/src/internet/model/ipv4-l3-protocol.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/ipv4-l3-protocol.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -687,9 +687,9 @@
     }
 }
 
-// XXX when should we set ip_id?   check whether we are incrementing
-// m_identification on packets that may later be dropped in this stack
-// and whether that deviates from Linux
+/// \todo when should we set ip_id?   check whether we are incrementing
+/// m_identification on packets that may later be dropped in this stack
+/// and whether that deviates from Linux
 Ipv4Header
 Ipv4L3Protocol::BuildHeader (
   Ipv4Address source,
--- a/src/internet/model/ipv6-extension-header.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/ipv6-extension-header.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -613,23 +613,23 @@
 
 void Ipv6ExtensionESPHeader::Print (std::ostream &os) const
 {
-  /* \todo */
+  /** \todo */
 }
 
 uint32_t Ipv6ExtensionESPHeader::GetSerializedSize () const
 {
-  /* \todo */
+  /** \todo */
   return 0;
 }
 
 void Ipv6ExtensionESPHeader::Serialize (Buffer::Iterator start) const
 {
-  /* \todo */
+  /** \todo */
 }
 
 uint32_t Ipv6ExtensionESPHeader::Deserialize (Buffer::Iterator start) 
 {
-  /* \todo */
+  /** \todo */
   return 0;
 }
 
@@ -659,23 +659,23 @@
 
 void Ipv6ExtensionAHHeader::Print (std::ostream &os) const
 {
-  /* \todo */
+  /** \todo */
 }
 
 uint32_t Ipv6ExtensionAHHeader::GetSerializedSize () const
 {
-  /* \todo */
+  /** \todo */
   return 0;
 }
 
 void Ipv6ExtensionAHHeader::Serialize (Buffer::Iterator start) const
 {
-  /* \todo */
+  /** \todo */
 }
 
 uint32_t Ipv6ExtensionAHHeader::Deserialize (Buffer::Iterator start) 
 {
-  /* \todo */ 
+  /** \todo */ 
   return 0;
 }
 
--- a/src/internet/model/ipv6-interface.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/ipv6-interface.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -323,7 +323,7 @@
   /* check if destination is localhost (::1) */
   if (DynamicCast<LoopbackNetDevice> (m_device))
     {
-      /* XXX additional checks needed here (such as whether multicast
+      /** \todo additional checks needed here (such as whether multicast
        * goes to loopback)?
        */
       m_device->Send (p, m_device->GetBroadcast (), Ipv6L3Protocol::PROT_NUMBER);
--- a/src/internet/model/ipv6-l3-protocol.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/ipv6-l3-protocol.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -263,7 +263,7 @@
 
   if (flags & (1 << 6)) /* auto flag */
     {
-      /* XXX : add other L2 address case */
+      /** \todo add other L2 address case */
       if (Mac48Address::IsMatchingType (addr))
         {
           address = Ipv6InterfaceAddress (Ipv6Address::MakeAutoconfiguredAddress (Mac48Address::ConvertFrom (addr), network));
--- a/src/internet/model/ndisc-cache.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/ndisc-cache.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -182,7 +182,7 @@
   if (m_waiting.size () >= m_ndCache->GetUnresQlen ())
     {
       /* we store only m_unresQlen packet => first packet in first packet remove */
-      /* XXX report packet as 'dropped' */
+      /** \todo report packet as 'dropped' */
       m_waiting.remove (0);
     }
   m_waiting.push_back (p);
@@ -191,7 +191,7 @@
 void NdiscCache::Entry::ClearWaitingPacket ()
 {
   NS_LOG_FUNCTION_NOARGS ();
-  /* XXX report packets as 'dropped' */
+  /** \todo report packets as 'dropped' */
   m_waiting.clear ();
 }
 
--- a/src/internet/model/nsc-tcp-l4-protocol.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/nsc-tcp-l4-protocol.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -450,7 +450,7 @@
           // IP address of the subnet but this was found to fail for
           // some use cases in /30 subnets.
 
-          // XXX
+          /// \todo Bug 1398 NSC's limitation to single-interface nodes
           m_nscStack->add_default_gateway (addrOss.str ().c_str ());
         }
     }
--- a/src/internet/model/nsc-tcp-socket-impl.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/nsc-tcp-socket-impl.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -843,7 +843,7 @@
     case NSC_EAGAIN: return ERROR_AGAIN;
     case NSC_EISCONN:   // fallthrough
     case NSC_EALREADY: return ERROR_ISCONN;
-    case NSC_ECONNREFUSED: return ERROR_NOROUTETOHOST;   // XXX, better mapping?
+    case NSC_ECONNREFUSED: return ERROR_NOROUTETOHOST;   /// \todo better mapping?
     case NSC_ECONNRESET:   // for no, all of these fall through
     case NSC_EHOSTDOWN:
     case NSC_ENETUNREACH:
@@ -851,7 +851,7 @@
     case NSC_EMSGSIZE: return ERROR_MSGSIZE;
     case NSC_ENOTCONN: return ERROR_NOTCONN;
     case NSC_ESHUTDOWN: return ERROR_SHUTDOWN;
-    case NSC_ETIMEDOUT: return ERROR_NOTCONN;   // XXX - this mapping isn't correct
+    case NSC_ETIMEDOUT: return ERROR_NOTCONN;   /// \todo this mapping isn't correct
     case NSC_ENOTDIR:   // used by eg. sysctl(2). Shouldn't happen normally,
     // but is triggered by e.g. show_config().
     case NSC_EUNKNOWN: return ERROR_INVAL;   // Catches stacks that 'return -1' without real mapping
--- a/src/internet/model/nsc-tcp-socket-impl.h	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/nsc-tcp-socket-impl.h	Wed Jul 03 14:43:10 2013 -0700
@@ -102,7 +102,7 @@
   void ConnectionSucceeded ();
 
   // Manage data tx/rx
-  // XXX This should be virtual and overridden
+  /// \todo This should be virtual and overridden
   Ptr<NscTcpSocketImpl> Copy ();
 
   // attribute related
--- a/src/internet/model/pending-data.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/pending-data.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -124,7 +124,7 @@
 uint32_t PendingData::SizeFromOffset (uint32_t offset)
 { // Find out how much data is available from offset
   NS_LOG_FUNCTION (this << offset);
-  // XXX should this return zero, or error out?
+  /// \todo should this return zero, or error out?
   if (offset > size) return 0;     // No data at requested offset
   return size - offset;            // Available data after offset
 }
--- a/src/internet/model/tcp-header.h	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/tcp-header.h	Wed Jul 03 14:43:10 2013 -0700
@@ -47,7 +47,9 @@
   virtual ~TcpHeader ();
 
   /**
-   * \brief Enable checksum calculation for TCP (XXX currently has no effect)
+   * \brief Enable checksum calculation for TCP
+   *
+   * \todo currently has no effect
    */
   void EnableChecksums (void);
 //Setters
--- a/src/internet/model/tcp-l4-protocol.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/tcp-l4-protocol.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -612,7 +612,8 @@
 
   TcpHeader outgoingHeader = outgoing;
   outgoingHeader.SetLength (5); //header length in units of 32bit words
-  /* outgoingHeader.SetUrgentPointer (0); //XXX */
+  /** \todo UrgentPointer */
+  /* outgoingHeader.SetUrgentPointer (0); */
   if(Node::ChecksumEnabled ())
     {
       outgoingHeader.EnableChecksums ();
@@ -663,7 +664,8 @@
     }
   TcpHeader outgoingHeader = outgoing;
   outgoingHeader.SetLength (5); //header length in units of 32bit words
-  /* outgoingHeader.SetUrgentPointer (0); //XXX */
+  /** \todo UrgentPointer */
+  /* outgoingHeader.SetUrgentPointer (0); */
   if(Node::ChecksumEnabled ())
     {
       outgoingHeader.EnableChecksums ();
--- a/src/internet/model/udp-socket-impl.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/model/udp-socket-impl.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -734,8 +734,10 @@
   return 0;
 }
 
-// XXX maximum message size for UDP broadcast is limited by MTU
+
+//  maximum message size for UDP broadcast is limited by MTU
 // size of underlying link; we are not checking that now.
+/// \todo Check MTU size of underlying link
 uint32_t
 UdpSocketImpl::GetTxAvailable (void) const
 {
--- a/src/internet/test/global-route-manager-impl-test-suite.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/internet/test/global-route-manager-impl-test-suite.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -200,7 +200,7 @@
 
   Simulator::Run ();
 
-// XXX here we should do some verification of the routes built
+/// \todo here we should do some verification of the routes built
 
   Simulator::Destroy ();
 
@@ -208,7 +208,7 @@
   // all of the LSAs, which each destroys the attached LinkRecords.
   delete srm;
 
-  // XXX
+  /// \todo Testing
   // No testing has actually been done other than making sure that this code
   // does not crash
 }
--- a/src/lte/model/lte-ue-mac.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/lte/model/lte-ue-mac.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -690,8 +690,8 @@
                     {
                       RecvRaResponse (it->rarPayload);
                       /// \todo RRC generates the RecvRaResponse messaged
-                      // for avoiding holes in transmission at PHY layer
-                      // (which produce erroneous UL CQI evaluation)
+                      /// for avoiding holes in transmission at PHY layer
+                      /// (which produce erroneous UL CQI evaluation)
                     }
                 }
             }
--- a/src/mesh/helper/mesh-helper.h	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/mesh/helper/mesh-helper.h	Wed Jul 03 14:43:10 2013 -0700
@@ -119,7 +119,8 @@
    * Set PHY standard
    */
   void SetStandard (enum WifiPhyStandard standard);
-  //void SetMeshId (std::string s); // XXX
+  /// \todo SetMeshId 
+  //void SetMeshId (std::string s);
   /** 
    *  \brief Spread/not spread frequency channels of MP interfaces. 
    * 
--- a/src/mpi/model/distributed-simulator-impl.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/mpi/model/distributed-simulator-impl.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -499,8 +499,8 @@
 Time
 DistributedSimulatorImpl::GetMaximumSimulationTime (void) const
 {
-  // XXX: I am fairly certain other compilers use other non-standard
-  // post-fixes to indicate 64 bit constants.
+  /// \todo I am fairly certain other compilers use other non-standard
+  /// post-fixes to indicate 64 bit constants.
   return TimeStep (0x7fffffffffffffffLL);
 }
 
--- a/src/network/model/packet.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/network/model/packet.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -584,7 +584,7 @@
     }
 
   //Tag size
-  //XXX
+  /// \todo Serialze Tags size
   //size += m_tags.GetSerializedSize ();
 
   // increment total size by size of meta-data 
@@ -658,7 +658,7 @@
     }
 
   // Serialize Tags
-  // XXX
+  /// \todo Serialize Tags
 
   // Serialize Metadata
   uint32_t metaSize = m_metadata.GetSerializedSize ();
@@ -756,7 +756,7 @@
     }
 
   // read tags
-  //XXX
+  /// \todo Deserialize Tags
   //uint32_t tagsDeserialized = m_tags.Deserialize (buffer.Begin ());
   //buffer.RemoveAtStart (tagsDeserialized);
 
--- a/src/network/test/buffer-test.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/network/test/buffer-test.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -58,9 +58,8 @@
     }
 }
 
-/* Note: works only when variadic macros are
+/** \todo Works only when variadic macros are
  * available which is the case for gcc.
- * XXX
  */
 #define ENSURE_WRITTEN_BYTES(buffer, n, ...)                    \
   {                                                             \
--- a/src/olsr/model/olsr-routing-protocol.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/olsr/model/olsr-routing-protocol.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -3085,6 +3085,7 @@
       if (numOifAddresses == 1) {
           ifAddr = m_ipv4->GetAddress (interfaceIdx, 0);
         } else {
+          /// \todo Implment IP aliasing and OLSR
           NS_FATAL_ERROR ("XXX Not implemented yet:  IP aliasing and OLSR");
         }
       rtentry->SetSource (ifAddr.GetLocal ());
@@ -3178,6 +3179,7 @@
       if (numOifAddresses == 1) {
           ifAddr = m_ipv4->GetAddress (interfaceIdx, 0);
         } else {
+          /// \todo Implment IP aliasing and OLSR
           NS_FATAL_ERROR ("XXX Not implemented yet:  IP aliasing and OLSR");
         }
       rtentry->SetSource (ifAddr.GetLocal ());
--- a/src/wifi/model/aarf-wifi-manager.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wifi/model/aarf-wifi-manager.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -227,8 +227,8 @@
 AarfWifiManager::DoGetRtsMode (WifiRemoteStation *st)
 {
   NS_LOG_FUNCTION (this << st);
-  // XXX: we could/should implement the Aarf algorithm for
-  // RTS only by picking a single rate within the BasicRateSet.
+  /// \todo we could/should implement the Aarf algorithm for
+  /// RTS only by picking a single rate within the BasicRateSet.
   AarfWifiRemoteStation *station = (AarfWifiRemoteStation *) st;
   return GetSupported (station, 0);
 }
--- a/src/wifi/model/aarfcd-wifi-manager.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wifi/model/aarfcd-wifi-manager.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -305,8 +305,8 @@
 AarfcdWifiManager::DoGetRtsMode (WifiRemoteStation *st)
 {
   NS_LOG_FUNCTION (this << st);
-  // XXX: we could/should implement the Aarf algorithm for
-  // RTS only by picking a single rate within the BasicRateSet.
+  /// \todo we could/should implement the Aarf algorithm for
+  /// RTS only by picking a single rate within the BasicRateSet.
   AarfcdWifiRemoteStation *station = (AarfcdWifiRemoteStation *) st;
   return GetSupported (station, 0);
 }
--- a/src/wifi/model/amrr-wifi-manager.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wifi/model/amrr-wifi-manager.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -321,7 +321,7 @@
   NS_LOG_FUNCTION (this << st);
   AmrrWifiRemoteStation *station = (AmrrWifiRemoteStation *)st;
   UpdateMode (station);
-  // XXX: can we implement something smarter ?
+  /// \todo can we implement something smarter ?
   return GetSupported (station, 0);
 }
 
--- a/src/wifi/model/arf-wifi-manager.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wifi/model/arf-wifi-manager.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -199,8 +199,8 @@
 ArfWifiManager::DoGetRtsMode (WifiRemoteStation *st)
 {
   NS_LOG_FUNCTION (this << st);
-  // XXX: we could/should implement the Arf algorithm for
-  // RTS only by picking a single rate within the BasicRateSet.
+  /// \todo we could/should implement the Arf algorithm for
+  /// RTS only by picking a single rate within the BasicRateSet.
   ArfWifiRemoteStation *station = (ArfWifiRemoteStation *) st;
   return GetSupported (station, 0);
 }
--- a/src/wifi/model/cara-wifi-manager.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wifi/model/cara-wifi-manager.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -175,8 +175,8 @@
 CaraWifiManager::DoGetRtsMode (WifiRemoteStation *st)
 {
   NS_LOG_FUNCTION (this << st);
-  // XXX: we could/should implement the Arf algorithm for
-  // RTS only by picking a single rate within the BasicRateSet.
+  /// \todo we could/should implement the Arf algorithm for
+  /// RTS only by picking a single rate within the BasicRateSet.
   return GetSupported (st, 0);
 }
 
--- a/src/wifi/model/mac-low.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wifi/model/mac-low.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -1012,8 +1012,8 @@
       DoNavResetNow (duration);
       return;
     }
-  // XXX Note that we should also handle CF_END specially here
-  // but we don't for now because we do not generate them.
+  /// \todo We should also handle CF_END specially here
+  /// but we don't for now because we do not generate them.
   else if (hdr.GetAddr1 () != m_self)
     {
       // see section 9.2.5.4 802.11-1999
@@ -1128,9 +1128,9 @@
 {
   NS_LOG_FUNCTION (this);
   NS_LOG_DEBUG ("cts timeout");
-  // XXX: should check that there was no rx start before now.
-  // we should restart a new cts timeout now until the expected
-  // end of rx if there was a rx start before now.
+  /// \todo should check that there was no rx start before now.
+  /// we should restart a new cts timeout now until the expected
+  /// end of rx if there was a rx start before now.
   m_stationManager->ReportRtsFailed (m_currentHdr.GetAddr1 (), &m_currentHdr);
   m_currentPacket = 0;
   MacLowTransmissionListener *listener = m_listener;
@@ -1142,9 +1142,9 @@
 {
   NS_LOG_FUNCTION (this);
   NS_LOG_DEBUG ("normal ack timeout");
-  // XXX: should check that there was no rx start before now.
-  // we should restart a new ack timeout now until the expected
-  // end of rx if there was a rx start before now.
+  /// \todo should check that there was no rx start before now.
+  /// we should restart a new ack timeout now until the expected
+  /// end of rx if there was a rx start before now.
   m_stationManager->ReportDataFailed (m_currentHdr.GetAddr1 (), &m_currentHdr);
   MacLowTransmissionListener *listener = m_listener;
   m_listener = 0;
--- a/src/wifi/model/onoe-wifi-manager.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wifi/model/onoe-wifi-manager.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -267,7 +267,7 @@
 {
   OnoeWifiRemoteStation *station = (OnoeWifiRemoteStation *)st;
   UpdateMode (station);
-  // XXX: can we implement something smarter ?
+  /// \todo can we implement something smarter ?
   return GetSupported (station, 0);
 }
 
--- a/src/wimax/model/bs-scheduler-simple.cc	Wed Jul 03 21:43:05 2013 +0200
+++ b/src/wimax/model/bs-scheduler-simple.cc	Wed Jul 03 14:43:10 2013 -0700
@@ -162,7 +162,7 @@
 
               if (availableSymbols <= BurstSizeSymbols)
                 {
-                  availableSymbols -= BurstSizeSymbols; // XXX: Overflows but don't know how to fix
+                  availableSymbols -= BurstSizeSymbols; /// \todo Overflows but don't know how to fix
                   break;
                 }
             }