Permalink
Browse files

doc: fixes. added a link to the manual.

  • Loading branch information...
1 parent ec3a1f6 commit 063d92e8cc858d5a4dcae920e6c3c67fa090bf52 @rhornig rhornig committed Feb 24, 2012
Showing with 16 additions and 4 deletions.
  1. +10 −0 _scripts/makedist
  2. +2 −1 doxy.cfg
  3. +3 −2 src/inet-index.ned
  4. +1 −1 src/networklayer/manetrouting/OLSR_ETX.ned
View
10 _scripts/makedist
@@ -1,5 +1,14 @@
#!/bin/sh
+# before running this script:
+# 1. build the INET documentation from the IDE:
+# * be sure to switch off auto linking (i.e. enable tilde linking)
+# * enable ALL features in the project properties dialog
+# * be sure to have a 72DPI screen when generating the sources
+# * after building the documentation grep for 'class="error"' in the neddoc
+# folder to be sure that there are no broken tilde links
+# 2. build the inet manual and copy the generated PDF file to the doc directory.
+
cd `dirname $0`/.. || { echo --- error changing to the inet root directory ---; exit 1;}
INET_ROOT=`pwd`
@@ -23,6 +32,7 @@ git checkout-index -a -f --prefix=$INET_ROOT/out/$DIRNAME/ || { echo --- error c
cp -r doc/doxy $INET_ROOT/out/$DIRNAME/doc || { echo --- error copying generated docs ---; exit 1;}
cp -r doc/neddoc $INET_ROOT/out/$DIRNAME/doc || { echo --- error copying generated docs ---; exit 1;}
cp -r doc/index.html $INET_ROOT/out/$DIRNAME/doc || { echo --- error copying generated docs ---; exit 1;}
+cp -r doc/inet-manual*.pdf $INET_ROOT/out/$DIRNAME/doc || { echo --- error copying generated docs ---; exit 1;}
# switch to the destination dir
cd $INET_ROOT/out/$DIRNAME
View
3 doxy.cfg
@@ -610,7 +610,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT =
+INPUT = src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -642,6 +642,7 @@ RECURSIVE = YES
EXCLUDE = obsolete \
tests \
+ 3rdparty \
doc/src
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
View
5 src/inet-index.ned
@@ -31,11 +31,12 @@
// for mobility and wireless communication has been derived from the
// <a href="http://mobility-fw.sourceforge.net" target="_blank">Mobility Framework</a>.
//
-// There are several other bugfixes and improvements as well; see the
-// <tt><a href="whatsnew.html">WHATSNEW</a></tt> file in the distribution.
+// See the <tt><a href="whatsnew.html">WHATSNEW</a></tt> file in the distribution
+// for the list of recent changes.
//
// Introductory material:
// - <a href="inet-architecture.html">INET Framework architecture</a>
+// - <a href="../inet-manual-draft.pdf">INET Framework Manual (draft) (pdf)</a>
// - <a href="../walkthrough/tutorial.html" target="_top">Guided Tour</a>
//
// A few useful starting points for browsing the documentation:
View
2 src/networklayer/manetrouting/OLSR_ETX.ned
@@ -35,7 +35,7 @@ import inet.networklayer.IManetRouting;
// - IPv4 address size is assumed in the messages. If you need IPv6, recompile with -DOLSR_IPv6 added to CFLAGS
// - Multiple interfaces per OLSR node is supported only with adding -DMULTIPLE_IFACES_SUPPORT to CFLAGS
//
-// see: <a>http://www.inf.ufrgs.br/~wlccordeiro/resources/olsr/README.html</a>
+// see: <a>http://www.inf.ufrgs.br/~~wlccordeiro/resources/olsr/README.html</a>
//
simple OLSR_ETX extends BaseRouting like IManetRouting
{

0 comments on commit 063d92e

Please sign in to comment.