Documentation updates

README

@@ -20,7 +20,8 @@ See the WHATSNEW file for recent changes.
 
 GETTING STARTED
 ---------------
-You may start by downloading and installing the INET demo on Windows.
+You may start by downloading and installing the INET framework. Read the INSTALL
+file for further information.
 
 Then you can gather initial experience by following the INET tutorial. After
 that, you can learn the NED language from the OMNeT++ manual & sample
@@ -38,17 +39,16 @@ Finally, you will be ready to run your simulation. As you see, you may use
 the INET framework without writing any C++ code, as long as you use the
 available modules.
 
-To implement new protocols or modify existing ones, you'll need to
-download the INET source, compile it yourself, then start adding/modifying
-source files yourself.
+To implement new protocols or modify existing ones, you'll need to add your 
+code somewhere under the src directory. If you add new files under the 'src' 
+directory you will need to regenerate the makefiles (using the 'make makefiles' 
+command).
 
-It is a workable approach to compile your C++ code as shared library (.so on
-Linux/Unix), and get the INET executable load it dynamically.
-
-If you want to use extarnal intefaces in INET, please install libpcap-dev (on linux)
+If you want to use external interfaces in INET, please install libpcap-dev (on linux)
 or winpcap (on windows from www.winpcap.org), then re-run the omnetpp configuration
 script (./configure). You should also enable the pcap support by editing the
-src/makefrag and the regeneration the INET makefiles (with the "make makefiles" command)
+src/makefrag and then regenerating the INET makefiles (using the "make makefiles" 
+command).
 
 Directory structure
 -------------------
@@ -121,4 +121,5 @@ Bottom-up:
    mpls/                 for the MPLS models
    newtcp/               for the TCP model
 
+ 3rdparty/               optional 3rd party components like (Network Simulation Cradle etc.)
 

WHATSNEW

@@ -1,27 +1,24 @@
 Recent changes in the INET Framework
 ====================================
 
-INET-201003XX
-
-- added "label" annotations to gates and modules to support
-  the enhanced editing functionality and palette filtering 
-  in OMNeT++ 4.1. (modules relevant to the current editing 
-  context will show up first in the palette.)
+INET-20100323
+-------------
+- added "label" annotations to gates and modules to support the adaptive palette
+  filtering and gate matching in the connection chooser (OMNeT++ 4.1).
 
-- added SCTP patch from Michael Tuexen, Irene Ruengeler and
+- updated SCTP implementation by Michael Tuexen, Irene Ruengeler and
   Thomas Dreibholz
 
 - added support for Sam Jensen's Network Simulation Cradle,
-  http://www.wand.net.nz/~stj2/nsc/, which makes real-world TCP stacks
-  available in simulations. Currently NSC supports the FreeBSD, OpenBSD,
-  lwIP and Linux stacks. Our TCP_NSC module (transport/tcp_nsc) is
-  a drop-in replacement for the normal TCP module (transport/tcp),
-  and can be activated with a single parameter setting in StandardHost.
-  See src/transport/tcp_nsc, 3rdparty/README, and examples/inet/simpletest.
-
-- added TCP SACK and New Reno implementation by Thomas Reschka.
-  The original TCP version is still available as TCP_old.
-  See src/transport/tcp/ChangeLog for details.
+  http://www.wand.net.nz/~stj2/nsc/, which makes real-world TCP stacks available 
+  in simulations. Currently NSC supports the FreeBSD, OpenBSD, lwIP and Linux 
+  stacks. The TCP_NSC module (transport/tcp_nsc) is a drop-in replacement for the 
+  normal TCP module (transport/tcp), and can be activated with a single parameter 
+  setting in StandardHost. See src/transport/tcp_nsc, 3rdparty/README, and 
+  examples/inet/tcpclientserver.
+
+- added TCP SACK and New Reno implementation by Thomas Reschka. The original TCP 
+  version is still available as TCP_old. See src/transport/tcp/ChangeLog for details.
 
 INET-20090325
 -------------

_scripts/makedist

@@ -10,7 +10,7 @@ if [ "$BUILDID" = "" ]; then
 fi
 
 FILENAME=$INET_ROOT/inet-$BUILDID-src.tgz
-DIRNAME=inet-$BUILDDATE
+DIRNAME=inet
 
 rm -rf $INET_ROOT/out/$DIRNAME
 mkdir -p $INET_ROOT/out/$DIRNAME

doxy.cfg

@@ -464,7 +464,7 @@ EXCLUDE_PATTERNS       = *_m.cc \
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = .
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

src/index.h

@@ -0,0 +1,26 @@
+//
+// Copyright (C) 2010 Andras Varga
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public License
+// as published by the Free Software Foundation; either version 2
+// of the License, or (at your option) any later version.
+//
+// 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 Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with this program; if not, see <http://www.gnu.org/licenses/>.
+//
+
+// This file is used only during the doxygen documentation generation.
+
+/**
+ * @page WHATSNEW What's New
+ *
+ * @verbinclude WHATSNEW
+ */
+
+

src/inet-index.ned

@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2003 Andras Varga
+// Copyright (C) 2010 Andras Varga
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public License
@@ -19,9 +19,9 @@
 // @titlepage
 //
 // <center><h1>INET Framework for OMNeT++/OMNEST</h1></center>
-// <center>release ##BUILDID##</center>
+// <center>release 20100323-defe196</center>
 //
-// <nohtml>INET Framework contains IPv4, IPv6, TCP, UDP protocol implementations,
+// <nohtml>INET Framework contains IPv4, IPv6, TCP, SCTP, UDP protocol implementations,
 // and several application models. The framework also includes an MPLS model
 // with \RSVP-TE and LDP signalling. Link-layer models are PPP, Ethernet and 802.11.
 // Static routing can be set up using network autoconfigurators, or one can use
@@ -32,26 +32,15 @@
 // for mobility and wireless communication has been derived from the
 // <a href="http://mobility-fw.sourceforge.net" target="_blank">Mobility Framework</a>.
 //
-// <b>This release features a new <a href="ieee80211.html">IEEE 802.11 model</a>,
-// which supports both ad-hoc and infrastructure mode.</b>
-//
 // There are several other bugfixes and improvements as well; see the
-// <tt>WHATSNEW</tt> file in the distribution.
-//
-// Recent additions: \MPLS, \RSVP-TE and \LDP models revised/rewritten (Vojta Janota);
-// dynamic routing (OSPFv2 and RIP) provided by the Quagga Linux/*nix routing daemon
-// (ported into the INET Framework by Vojta Janota);
-// and a cleanroom \OSPFv2 model (by Andras Babos).
-//
-// <a href="history.html">History and contributors</a>.
+// <tt><a href="../doxy/whatsnew.html">WHATSNEW</a></tt> file in the distribution.
 //
 // Introductory material:
-//  - <a href="inet-architecture.html">INET Framework architecture</a> <b>(NEW!)</b>
+//  - <a href="inet-architecture.html">INET Framework architecture</a>
 //  - <a href="../walkthrough/tutorial.html" target="_top">Guided Tour</a>
-//  - <a href="../tcp-tutorial/index.html" target="_top">Getting started with TCP</a>
 //
 // A few useful starting points for browsing the documentation:
-//  - the <a href="full-usage-diagram.html">Usage Diagram</a>
+//  - the <a href="full-ned-usage-diagram.html">Usage Diagram</a>
 //    includes all modules and networks
 //  - example networks: NClients, BulkTransfer, MulticastNetwork,
 //    ARPTest, MixedLAN, etc.
@@ -96,6 +85,8 @@
 // Related documentation:
 //   - <a href="../doxy/index.html" target="_top">C++ source documentation (Doxygen)</a>
 //
+// <a href="history.html">History and contributors</a>.
+//
 // @page history.html, History
 //
 // The predecessor of the INET framework was written by Klaus
@@ -152,6 +143,15 @@
 // got first included in the July 2005 INET snapshot, and gradually refined
 // afterwards.
 //
+// The \SCTP implementation was contributed by Michael Tuexen, Irene Ruengeler 
+// and Thomas Dreibholz
+//
+// Support for Sam Jensen's Network Simulation Cradle,
+// which makes real-world \TCP stacks available in simulations was added
+// by Zoltan Bojthe in 2010.
+//
+// \TCP SACK and New Reno implementation was contributed by Thomas Reschka.
+//
 // Several other people have contributed to the INET Framework by providing
 // feedback, reporting bugs, suggesting features and contributing patches;
 // I'd like to acknowledge their help here as well.