doc/manual/source/documentation.rst
changeset 10991 54d908f84801
parent 10536 1c11f0a6ed36
child 11000 303c6b6d436f
equal deleted inserted replaced
10990:414d94e669c5 10991:54d908f84801
   474    Filtered Warnings
   474    Filtered Warnings
   475    ========================================
   475    ========================================
   476    src/mesh/helper/dot11s/dot11s-installer.h:72: warning: Member m_root (variable) of class ns3::Dot11sStack is not documented.
   476    src/mesh/helper/dot11s/dot11s-installer.h:72: warning: Member m_root (variable) of class ns3::Dot11sStack is not documented.
   477    src/mesh/helper/dot11s/dot11s-installer.h:35: warning: return type of member ns3::Dot11sStack::GetTypeId is not documented
   477    src/mesh/helper/dot11s/dot11s-installer.h:35: warning: return type of member ns3::Dot11sStack::GetTypeId is not documented
   478    src/mesh/helper/dot11s/dot11s-installer.h:56: warning: return type of member ns3::Dot11sStack::InstallStack is not documented
   478    src/mesh/helper/dot11s/dot11s-installer.h:56: warning: return type of member ns3::Dot11sStack::InstallStack is not documented
   479    src/mesh/helper/flame/flame-installer.h:40: warning: Member GetTypeId() (function) of class ns3::FlameStack is not documented.
   479    src/mesh/helper/flame/lfame-installer.h:40: warning: Member GetTypeId() (function) of class ns3::FlameStack is not documented.
   480    src/mesh/helper/flame/flame-installer.h:60: warning: return type of member ns3::FlameStack::InstallStack is not documented
   480    src/mesh/helper/flame/flame-installer.h:60: warning: return type of member ns3::FlameStack::InstallStack is not documented
   481    src/mesh/helper/mesh-helper.h:213: warning: Member m_nInterfaces (variable) of class ns3::MeshHelper is not documented.
   481    src/mesh/helper/mesh-helper.h:213: warning: Member m_nInterfaces (variable) of class ns3::MeshHelper is not documented.
   482    src/mesh/helper/mesh-helper.h:214: warning: Member m_spreadChannelPolicy (variable) of class ns3::MeshHelper is not documented.
   482    src/mesh/helper/mesh-helper.h:214: warning: Member m_spreadChannelPolicy (variable) of class ns3::MeshHelper is not documented.
   483    src/mesh/helper/mesh-helper.h:215: warning: Member m_stack (variable) of class ns3::MeshHelper is not documented.
   483    src/mesh/helper/mesh-helper.h:215: warning: Member m_stack (variable) of class ns3::MeshHelper is not documented.
   484    src/mesh/helper/mesh-helper.h:216: warning: Member m_stackFactory (variable) of class ns3::MeshHelper is not documented.
   484    src/mesh/helper/mesh-helper.h:216: warning: Member m_stackFactory (variable) of class ns3::MeshHelper is not documented.
   517      *
   517      *
   518      *  Foo packet type.
   518      *  Foo packet type.
   519     */
   519     */
   520     class Foo
   520     class Foo
   521 
   521 
       
   522 * Did you know ``typedef``s can have formal arguments?  This enables
       
   523   documentation of function pointer signatures::
       
   524 
       
   525     /**
       
   526      * Bar callback function signature.
       
   527      *
       
   528      * \param ale The size of a pint of ale, in Imperial ounces.
       
   529      */
       
   530     typedef void (* BarCallback)(const int ale);
       
   531     
   522 * Copy the ``Attribute`` help strings from the ``GetTypeId`` method to use
   532 * Copy the ``Attribute`` help strings from the ``GetTypeId`` method to use
   523   as the brief descriptions of associated members.
   533   as the brief descriptions of associated members.
   524 
   534 
   525 * ``\bugid{298}`` will create a link to bug 298 in our Bugzilla.
   535 * ``\bugid{298}`` will create a link to bug 298 in our Bugzilla.
   526 
   536