get rid of texi2html warnings
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Fri, 10 Dec 2010 13:47:30 +0100
changeset 6680 0e81f526bd49
parent 6679 3496cb66848e
child 6681 df822f566004
get rid of texi2html warnings
doc/manual/attributes.texi
doc/manual/internet.texi
doc/manual/new-models.texi
doc/manual/random.texi
doc/manual/tracing.texi
doc/manual/troubleshoot.texi
doc/manual/wimax.texi
--- a/doc/manual/attributes.texi	Wed Dec 08 23:43:15 2010 +0000
+++ b/doc/manual/attributes.texi	Fri Dec 10 13:47:30 2010 +0100
@@ -117,7 +117,7 @@
 
 @verbatim
 class Node : public Object
-{
+@{
 public:
   static TypeId GetTypeId (void);
   ...
@@ -129,7 +129,7 @@
 @example
 TypeId 
 Node::GetTypeId (void)
-{
+@{
   static TypeId tid = TypeId ("ns3::Node")
     .SetParent<Object> ()
     .AddConstructor<Node> ()
@@ -148,7 +148,7 @@
                    MakeUintegerChecker<uint32_t> ())
     ;
   return tid;
-}
+@}
 @end example
 @end smallformat
 
@@ -266,7 +266,7 @@
 NS_OBJECT_ENSURE_REGISTERED (DropTailQueue);
 
 TypeId DropTailQueue::GetTypeId (void) 
-{
+@{
   static TypeId tid = TypeId ("ns3::DropTailQueue")
     .SetParent<Queue> ()
     .AddConstructor<DropTailQueue> ()
@@ -278,7 +278,7 @@
     ;
   
   return tid;
-}
+@}
 @end example
 @end smallformat
 
@@ -325,7 +325,7 @@
 
 int 
 main (int argc, char *argv[])
-{
+@{
 
   // By default, the MaxPackets attribute has a value of 100 packets
   // (this default can be observed in the function DropTailQueue::GetTypeId)
@@ -542,10 +542,10 @@
 
 @verbatim
 ConfigStore::ConfigStore ()
-{
+@{
   ObjectBase::ConstructSelf (AttributeList ());
   // continue on with constructor.
-}
+@}
 @end verbatim
 
 @node Extending attributes
@@ -591,7 +591,7 @@
 @example
 TypeId
 RandomWalk2dMobilityModel::GetTypeId (void)
-{
+@{
   static TypeId tid = TypeId ("ns3::RandomWalk2dMobilityModel")
     .SetParent<MobilityModel> ()
     .SetGroupName ("Mobility")
@@ -609,7 +609,7 @@
     // etc (more parameters).
     ;
   return tid;
-}
+@}
 @end example
 @end smallformat
 
@@ -649,14 +649,14 @@
  * \brief a 2d rectangle
  */
 class Rectangle
-{
+@{
   ...
 
   double xMin;
   double xMax;
   double yMin;
   double yMax;
-};
+@};
 @end example
 @end smallformat
  
@@ -682,25 +682,25 @@
 
 std::ostream &
 operator << (std::ostream &os, const Rectangle &rectangle)
-{
+@{
   os << rectangle.xMin << "|" << rectangle.xMax << "|" << rectangle.yMin << "|"
      << rectangle.yMax;
   return os;
-}
+@}
 std::istream &
 operator >> (std::istream &is, Rectangle &rectangle)
- {
+@{
   char c1, c2, c3;
   is >> rectangle.xMin >> c1 >> rectangle.xMax >> c2 >> rectangle.yMin >> c3 
      >> rectangle.yMax;
   if (c1 != '|' ||
       c2 != '|' ||
       c3 != '|')
-    {
+    @{
       is.setstate (std::ios_base::failbit);
-    }
+    @}
   return is;
-}
+@}
 @end example
 @end smallformat
 
@@ -737,7 +737,7 @@
 #include "contrib-module.h"
 ...
 int main (...)
-{
+@{
   // setup topology
 
   // Invoke just before entering Simulator::Run ()
@@ -746,7 +746,7 @@
   config.ConfigureAttributes ();
 
   Simulator::Run ();
-}
+@}
 @end example
 @end smallformat
 
@@ -815,7 +815,7 @@
 #include "contrib-module.h"
 ...
 int main (...)
-{
+@{
 
   Config::SetDefault ("ns3::ConfigStore::Filename", StringValue ("input-defaults.xml"));
   Config::SetDefault ("ns3::ConfigStore::Mode", StringValue ("Load"));
@@ -839,7 +839,7 @@
   ConfigStore outputConfig;
   outputConfig.ConfigureAttributes ();
   Simulator::Run ();
-}
+@}
 @end example
 @end smallformat
 
--- a/doc/manual/internet.texi	Wed Dec 08 23:43:15 2010 +0000
+++ b/doc/manual/internet.texi	Fri Dec 10 13:47:30 2010 +0100
@@ -19,13 +19,13 @@
 @example
 void
 InternetStackHelper::Install (Ptr<Node> node) const
-{
+@{
   if (node->GetObject<Ipv4> () != 0)
-    {
+    @{
       NS_FATAL_ERROR ("InternetStackHelper::Install(): Aggregating "
                       "an InternetStack to a node with an existing Ipv4 object");
       return;
-    }
+    @}
 
   CreateAndAggregateObjectFromTypeId (node, "ns3::ArpL3Protocol");
   CreateAndAggregateObjectFromTypeId (node, "ns3::Ipv4L3Protocol");
@@ -38,7 +38,7 @@
   Ptr<Ipv4> ipv4 = node->GetObject<Ipv4> ();
   Ptr<Ipv4RoutingProtocol> ipv4Routing = m_routing->Create (node);
   ipv4->SetRoutingProtocol (ipv4Routing);
-}
+@}
 @end example
 @end smallformat
 
--- a/doc/manual/new-models.texi	Wed Dec 08 23:43:15 2010 +0000
+++ b/doc/manual/new-models.texi	Fri Dec 10 13:47:30 2010 +0100
@@ -453,10 +453,10 @@
 @example
   void
 PointToPointNetDevice::SetReceiveErrorModel (Ptr<ErrorModel> em)
-{
+@{
   NS_LOG_FUNCTION (this << em);
   m_receiveErrorModel = em;
-} 
+@} 
 
    .AddAttribute ("ReceiveErrorModel",
                    "The receiver error model used to simulate packet loss",
@@ -471,20 +471,20 @@
 @smallformat
 @example
 void PointToPointNetDevice::Receive (Ptr<Packet> packet)
-{
+@{
   NS_LOG_FUNCTION (this << packet);
   uint16_t protocol = 0;
   
   if (m_receiveErrorModel && m_receiveErrorModel->IsCorrupt (packet) )
-    {
+    @{
 //  
 // If we have an error model and it indicates that it is time to lose a
 // corrupted packet, don't forward this packet up, let it go. 
 // 
       m_dropTrace (packet);
-    } 
+    @} 
   else
-    {
+    @{
 //  
 // Hit the receive trace hook, strip off the point-to-point protocol header
 // and forward this packet up the protocol stack.
@@ -493,11 +493,11 @@
       ProcessHeader(packet, protocol);
       m_rxCallback (this, packet, protocol, GetRemote ());
       if (!m_promiscCallback.IsNull ())
-        {           m_promiscCallback (this, packet, protocol, GetRemote (), 
+        @{           m_promiscCallback (this, packet, protocol, GetRemote (), 
                       GetAddress (), NetDevice::PACKET_HOST);
-        }
-    }
-}
+        @}
+    @}
+@}
 @end example
 @end smallformat
 
@@ -519,11 +519,11 @@
 
 bool
 ErrorModel::DoCorrupt (Packet& p)
-{
+@{
   NS_LOG_FUNCTION;
   NS_LOG_UNCOND("Corrupt!");
   return false;
-}
+@}
 @end example
 @end smallformat
 
@@ -564,7 +564,7 @@
 @smallformat
 @example
 class BasicErrorModel : public ErrorModel
-{
+@{
 public:
   static TypeId GetTypeId (void);
   ...
@@ -573,7 +573,7 @@
   virtual bool DoCorrupt (Ptr<Packet> p);
   virtual bool DoReset (void);
   ...
-}
+@}
 @end example
 @end smallformat
 
@@ -582,7 +582,7 @@
 
 @verbatim
 TypeId RateErrorModel::GetTypeId (void)
-{
+@{
   static TypeId tid = TypeId ("ns3::RateErrorModel")
     .SetParent<ErrorModel> ()
     .AddConstructor<RateErrorModel> ()
--- a/doc/manual/random.texi	Wed Dec 08 23:43:15 2010 +0000
+++ b/doc/manual/random.texi	Fri Dec 10 13:47:30 2010 +0100
@@ -259,7 +259,7 @@
 @example
 TypeId
 RandomPropagationDelayModel::GetTypeId (void)
-{ 
+@{ 
   static TypeId tid = TypeId ("ns3::RandomPropagationDelayModel")
     .SetParent<PropagationDelayModel> ()
     .AddConstructor<RandomPropagationDelayModel> ()
@@ -270,7 +270,7 @@
                    MakeRandomVariableChecker ())
     ;
   return tid;
-}
+@}
 @end example
 @end smallformat
 Here, the ns-3 user can change the default random variable for this
--- a/doc/manual/tracing.texi	Wed Dec 08 23:43:15 2010 +0000
+++ b/doc/manual/tracing.texi	Fri Dec 10 13:47:30 2010 +0100
@@ -146,10 +146,10 @@
 @smallformat
 @example
   class MyObject : public Object
-  {
+  @{
   public:
     static TypeId GetTypeId (void)
-    {
+    @{
       static TypeId tid = TypeId ("MyObject")
         .SetParent (Object::GetTypeId ())
         .AddConstructor<MyObject> ()
@@ -158,11 +158,11 @@
                          MakeTraceSourceAccessor (&MyObject::m_myInt))
         ;
       return tid;
-    }
+    @}
   
-    MyObject () {}
+    MyObject () @{@}
     TracedValue<uint32_t> m_myInt;
-  };
+  @};
 @end example
 @end smallformat
 
@@ -180,9 +180,9 @@
 @example
   void
   IntTrace (Int oldValue, Int newValue)
-  {
+  @{
     std::cout << ``Traced `` << oldValue << `` to `` << newValue << std::endl;
-  }
+  @}
 @end example
 @end smallformat
 
@@ -194,13 +194,13 @@
 @example
   int
   main (int argc, char *argv[])
-  {
+  @{
     Ptr<MyObject> myObject = CreateObject<MyObject> ();
   
     myObject->TraceConnectWithoutContext ("MyInteger", MakeCallback(&IntTrace));
 
     myObject->m_myInt = 1234;
-  }
+  @}
 @end example
 @end smallformat
 
@@ -250,7 +250,7 @@
 
 @smallformat
 @example
-  void CwndTracer (uint32_t oldval, uint32_t newval) {}
+  void CwndTracer (uint32_t oldval, uint32_t newval) @{@}
 
   ...
 
@@ -272,7 +272,7 @@
 
 @smallformat
 @example
-  void CwndTracer (uint32_t oldval, uint32_t newval) {}
+  void CwndTracer (uint32_t oldval, uint32_t newval) @{@}
 
   ...
 
@@ -476,7 +476,7 @@
 You can enable pcap tracing on a particular node/net-device pair by providing a
 @code{std::string} representing an object name service string to an 
 @code{EnablePcap} method.  The @code{Ptr<NetDevice>} is looked up from the name
-string.  Again, the @code<Node> is implicit since the named net device must 
+string.  Again, the @code{Node} is implicit since the named net device must 
 belong to exactly one @code{Node}.  For example, 
 
 @verbatim
@@ -489,7 +489,7 @@
 You can enable pcap tracing on a collection of node/net-device pairs by 
 providing a @code{NetDeviceContainer}.  For each @code{NetDevice} in the container
 the type is checked.  For each device of the proper type (the same type as is 
-managed by the device helper), tracing is enabled.    Again, the @code<Node> is 
+managed by the device helper), tracing is enabled.    Again, the @code{Node} is 
 implicit since the found net device must belong to exactly one @code{Node}.
 For example, 
 
@@ -676,7 +676,7 @@
 You can enable ascii tracing on a particular node/net-device pair by providing a
 @code{std::string} representing an object name service string to an 
 @code{EnablePcap} method.  The @code{Ptr<NetDevice>} is looked up from the name
-string.  Again, the @code<Node> is implicit since the named net device must 
+string.  Again, the @code{Node} is implicit since the named net device must 
 belong to exactly one @code{Node}.  For example, 
 
 @verbatim
@@ -713,7 +713,7 @@
 You can enable ascii tracing on a collection of node/net-device pairs by 
 providing a @code{NetDeviceContainer}.  For each @code{NetDevice} in the container
 the type is checked.  For each device of the proper type (the same type as is 
-managed by the device helper), tracing is enabled.    Again, the @code<Node> is 
+managed by the device helper), tracing is enabled.    Again, the @code{Node} is 
 implicit since the found net device must belong to exactly one @code{Node}.
 For example, 
 
@@ -1062,7 +1062,7 @@
 You can enable ascii tracing on a particular protocol by providing a 
 @code{std::string} representing an object name service string to an 
 @code{EnablePcap} method.  The @code{Ptr<Ipv4>} is looked up from the name
-string.  The @code<Node> in the resulting filenames is implicit since there
+string.  The @code{Node} in the resulting filenames is implicit since there
 is a one-to-one correspondence between protocol instances and nodes,
 For example, 
 
@@ -1096,7 +1096,7 @@
 You can enable ascii tracing on a collection of protocol/interface pairs by 
 providing an @code{Ipv4InterfaceContainer}.  For each protocol of the proper 
 type (the same type as is managed by the device helper), tracing is enabled
-for the corresponding interface.  Again, the @code<Node> is implicit since 
+for the corresponding interface.  Again, the @code{Node} is implicit since 
 there is a one-to-one correspondence between each protocol and its node.
 For example, 
 
--- a/doc/manual/troubleshoot.texi	Wed Dec 08 23:43:15 2010 +0000
+++ b/doc/manual/troubleshoot.texi	Fri Dec 10 13:47:30 2010 +0100
@@ -62,9 +62,9 @@
     at ../examples/tcp-point-to-point.cc:136
 136       Ptr<Socket> localSocket = socketFactory->CreateSocket ();
 (gdb) p localSocket
-$1 = {m_ptr = 0x3c5d65}
+$1 = @{m_ptr = 0x3c5d65@}
 (gdb) p socketFactory
-$2 = {m_ptr = 0x0}
+$2 = @{m_ptr = 0x0@}
 (gdb) quit
 The program is running.  Exit anyway? (y or n) y
 @end example
--- a/doc/manual/wimax.texi	Wed Dec 08 23:43:15 2010 +0000
+++ b/doc/manual/wimax.texi	Fri Dec 10 13:47:30 2010 +0100
@@ -87,7 +87,7 @@
 interact with the Wimax models is through the helper API and through
 the publicly visible attributes of the model.
 
-The helper API is defined in @code{src/helper/wimax-helper.{cc,h}}.  
+The helper API is defined in @code{src/helper/wimax-helper.@{cc,h@}}.  
 
 The example @code{examples/wimax/wimax-simple.cc} contains some basic
 code that shows how to set up the model:
@@ -95,7 +95,7 @@
 @smallformat
 @example
   switch (schedType)
-    {
+    @{
     case 0:
       scheduler = WimaxHelper::SCHED_TYPE_SIMPLE;
       break;
@@ -107,7 +107,7 @@
       break;
     default:
       scheduler = WimaxHelper::SCHED_TYPE_SIMPLE;
-    }
+    @}
 
   NodeContainer ssNodes;
   NodeContainer bsNodes;