From c59f21e4a9c3a6695a782dc3b423019675cf27ca Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Tue, 27 Dec 2011 14:30:54 -0800 Subject: [PATCH] clear warnings in manual build process --- doc/manual/source/attributes.rst | 6 ++++-- doc/manual/source/new-models.rst | 4 ++-- doc/manual/source/object-model.rst | 4 ++++ doc/manual/source/object-names.rst | 2 ++ doc/manual/source/python.rst | 6 +++--- doc/manual/source/tracing.rst | 2 +- 6 files changed, 16 insertions(+), 8 deletions(-) diff --git a/doc/manual/source/attributes.rst b/doc/manual/source/attributes.rst index dd4e00d23..c89c470d6 100644 --- a/doc/manual/source/attributes.rst +++ b/doc/manual/source/attributes.rst @@ -1,5 +1,7 @@ .. include:: replace.txt +.. _Attributes: + Attributes ---------- @@ -58,7 +60,7 @@ For most basic usage (syntax), treat a smart pointer like a regular pointer::: CreateObject ++++++++++++ -As we discussed above in :ref:`Memory management and class Ptr`, at the +As we discussed above in :ref:`Memory-management-and-class-Ptr`, at the lowest-level API, objects of type :cpp:class:`ns3::Object` are not instantiated using ``operator new`` as usual but instead by a templated function called :cpp:func:`CreateObject()`. @@ -412,7 +414,7 @@ determine the required concrete configuration namespaced path.:: Config::Set ("/Names/server/eth0/TxQueue/MaxPackets", UintegerValue (25)); -:ref:`Object names` for a fuller treatment of the |ns3| configuration namespace. +:ref:`Object-names` for a fuller treatment of the |ns3| configuration namespace. Setting through constructors helper classes +++++++++++++++++++++++++++++++++++++++++++ diff --git a/doc/manual/source/new-models.rst b/doc/manual/source/new-models.rst index f8788f6b2..e2f158344 100644 --- a/doc/manual/source/new-models.rst +++ b/doc/manual/source/new-models.rst @@ -249,7 +249,7 @@ use of class Object? This is an important design step; whether to use class :cpp:class:`Object` as a base class for your new classes. -As described in the chapter on the |ns3| :ref:`Object model`, classes that +As described in the chapter on the |ns3| :ref:`Object-model`, classes that inherit from class :cpp:class:`Object` get special properties: * the |ns3| type and attribute system (see :ref:`Attributes`) @@ -370,7 +370,7 @@ certain objects can be created via the object creation framework The macro ``NS_OBJECT_ENSURE_REGISTERED (classname)`` is needed also once for every class that defines a new GetTypeId method, and it does the actual -registration of the class into the system. The :ref:`Object model` chapter +registration of the class into the system. The :ref:`Object-model` chapter discusses this in more detail. how to include files from elsewhere diff --git a/doc/manual/source/object-model.rst b/doc/manual/source/object-model.rst index 29a6d9563..b51559707 100644 --- a/doc/manual/source/object-model.rst +++ b/doc/manual/source/object-model.rst @@ -1,5 +1,7 @@ .. include:: replace.txt +.. _Object-model: + Object model ------------ @@ -67,6 +69,8 @@ system. In practice, class :cpp:class:`Object` is the variant of the three above that the |ns3| developer will most commonly encounter. +.. _Memory-management-and-class-Ptr: + Memory management and class Ptr ******************************* diff --git a/doc/manual/source/object-names.rst b/doc/manual/source/object-names.rst index a50e7bd2b..932485368 100644 --- a/doc/manual/source/object-names.rst +++ b/doc/manual/source/object-names.rst @@ -1,5 +1,7 @@ .. include:: replace.txt +.. _Object-names: + Object names ------------ diff --git a/doc/manual/source/python.rst b/doc/manual/source/python.rst index 564b31436..c22392ab3 100644 --- a/doc/manual/source/python.rst +++ b/doc/manual/source/python.rst @@ -239,9 +239,9 @@ Organization of the Monolithic Python Bindings The monolithic Python API definitions are organized as follows. For each |ns3| module , the file ``bindings/python/ns3_module_.py`` describes its API. Each of those files have 3 toplevel functions: -#. :cpp:func:`def register_types(module)`: this function takes care of registering new types (e.g. C++ classes, enums) that are defined in tha module; -#. :cpp:func:`def register_methods(module)`: this function calls, for each class , another function register_methods_Ns3(module). These latter functions add method definitions for each class; -#. :cpp:func:`def register_functions(module)`: this function registers |ns3| functions that belong to that module. +#. :py:func:`def register_types(module)`: this function takes care of registering new types (e.g. C++ classes, enums) that are defined in tha module; +#. :py:func:`def register_methods(module)`: this function calls, for each class , another function register_methods_Ns3(module). These latter functions add method definitions for each class; +#. :py:func:`def register_functions(module)`: this function registers |ns3| functions that belong to that module. Modular Python Bindings *********************** diff --git a/doc/manual/source/tracing.rst b/doc/manual/source/tracing.rst index 9f138bfb2..27ca6f1a4 100644 --- a/doc/manual/source/tracing.rst +++ b/doc/manual/source/tracing.rst @@ -264,7 +264,7 @@ list, so "/NodeList/0" refers to the zeroth node in the list of nodes created by the simulation. This node is actually a ``Ptr`` and so is a subclass of an :cpp:class:`ns3::Object`. -As described in the :ref:`Object Model` section, |ns3| supports an object +As described in the :ref:`Object-model` section, |ns3| supports an object aggregation model. The next path segment begins with the "$" character which indicates a ``GetObject`` call should be made looking for the type that follows. When a node is initialized by an ``InternetStackHelper`` a number of interfaces