EmaMaker
/
tc-homework2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

organize doxygen modules alphabetically

Tom Henderson 2011-05-24 22:59:41 -07:00
parent 261e5fb98e
commit 67a2d856bf
5 changed files with 87 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/modules
View File

@ -30,28 +30,4 @@
* - a configuration class used to set and control all attributes and trace sources
* in a simulation: ns3::Config.
*
* @defgroup network Network
* The "network" module contains:
* - a packet class to create and manipulate simulation packets:
* ns3::Packet, ns3::Header, and ns3::Trailer. This packet class
* also supports per-packet ns3::Tag which are globs of data
* which can be attached to any packet.
* - a ns3::Node base class which should be subclassed by any new type of
* network Node.
* - models which abstract the MAC-layer from the IP layer protocols:
* ns3::NetDevice and ns3::Channel.
* - models which abstract the application-layer API: ns3::Application,
* ns3::Socket, ns3::SocketFactory, and, ns3::Udp
*
* @defgroup internet Internet
*
* The "internet" module contains:
* - an Ipv4 stack
* - an Ipv6 stack
* - an ARP module
* - a UDP and a TCP implementation
*
* @defgroup applications Applications
*
* @defgroup netanim Animation
*/

27
src/applications/doc/applications.h Normal file
View File

@ -0,0 +1,27 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef APPLICATIONS_H
#define APPLICATIONS_H
/**
* \defgroup applications Applications
*
* This section documents the API of the ns-3 applications module. For a generic functional description, please refer to the ns-3 manual.
*/
#endif /* APPLICATIONS_H */

27
src/internet/doc/internet.h Normal file
View File

@ -0,0 +1,27 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef INTERNET_H
#define INTERNET_H
/**
* \defgroup internet Internet
*
* This section documents the API of the ns-3 internet module. For a generic functional description, please refer to the ns-3 manual.
*/
#endif /* INTERNET_H */

6
src/netanim/model/animation-interface.h
View File

@ -34,6 +34,12 @@ namespace ns3 {
class NetModel;
/**
* \defgroup netanim Netanim
*
* This section documents the API of the ns-3 netanim module. For a generic functional description, please refer to the ns-3 manual.
*/
/**
* \ingroup netanim
*

27
src/network/doc/network.h Normal file
View File

@ -0,0 +1,27 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef NETWORK_H
#define NETWORK_H
/**
* \defgroup network Network
*
* This section documents the API of the ns-3 network module. For a generic functional description, please refer to the ns-3 manual.
*/
#endif /* NETWORK_H */