From bf4448ef432b8817aa4c42dfb953a2f72f0c52af Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Fri, 23 Mar 2007 12:17:53 +0000
Subject: [PATCH] moved Sniffer into new Examples directory
---
Doxyfile | 10 +++++-----
Examples/Doxyfile | 7 +++++++
Example.dox => Examples/Mainpage.dox | 11 ++++++++---
Examples/SConscript | 10 ++++++++++
{Sniffer => Examples/Sniffer}/SConscript | 0
{Sniffer => Examples/Sniffer}/Sniffer.cc | 0
Mainpage.dox | 4 ++--
SConstruct | 2 +-
doclib/doxy-header-overview.html | 1 +
doclib/doxy-header.html | 1 +
senfscons/Doxyfile | 2 ++
senfscons/Doxygen.py | 2 +-
senfscons/Mainpage.dox | 11 ++++++++---
13 files changed, 46 insertions(+), 15 deletions(-)
create mode 100644 Examples/Doxyfile
rename Example.dox => Examples/Mainpage.dox (98%)
create mode 100644 Examples/SConscript
rename {Sniffer => Examples/Sniffer}/SConscript (100%)
rename {Sniffer => Examples/Sniffer}/Sniffer.cc (100%)
diff --git a/Doxyfile b/Doxyfile
index 8b758e170..d29688fd2 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1,9 +1,9 @@
@INCLUDE = "$(TOPDIR)/doclib/Doxyfile.global"
-PROJECT_NAME = Overview
-PROJECT_NUMBER = "(Revision $(REVISION), generated $(TODAY))"
+PROJECT_NAME = Overview
+PROJECT_NUMBER = "(Revision $(REVISION), generated $(TODAY))"
-EXAMPLE_PATH = Sniffer
+HTML_HEADER = doclib/doxy-header-overview.html
+GENERATE_XML = NO
-HTML_HEADER = doclib/doxy-header-overview.html
-GENERATE_XML = NO
+GENERATE_TAGFILE = doc/overview.tag
\ No newline at end of file
diff --git a/Examples/Doxyfile b/Examples/Doxyfile
new file mode 100644
index 000000000..1cfe41940
--- /dev/null
+++ b/Examples/Doxyfile
@@ -0,0 +1,7 @@
+@INCLUDE = "$(TOPDIR)/doclib/Doxyfile.global"
+
+PROJECT_NAME = Examples
+TAGFILES = "$(TOPDIR)/Utils/doc/Utils.tag" "$(TOPDIR)/Socket/doc/Socket.tag" "$(TOPDIR)/Packets/doc/Packets.tag" "$(TOPDIR)/Scheduler/doc/Scheduler.tag" "$(TOPDIR)/doc/overview.tag"
+GENERATE_TAGFILE = doc/Examples.tag
+
+EXAMPLE_PATH = "Sniffer"
\ No newline at end of file
diff --git a/Example.dox b/Examples/Mainpage.dox
similarity index 98%
rename from Example.dox
rename to Examples/Mainpage.dox
index eb5a816b3..2bd029c62 100644
--- a/Example.dox
+++ b/Examples/Mainpage.dox
@@ -1,4 +1,10 @@
-/** \page example Sniffer: A simple example application
+/** \mainpage Examples
+ \anchor Examples_Main
+
+ \ref sniffer
+*/
+
+/** \page sniffer Sniffer: A simple example application
\dontinclude Sniffer.cc
@@ -57,8 +63,6 @@
specific type of socket which returns ethernet packets directly from the network wire. By
uncommenting the last line, you may switch the interface into promiscuous mode.
- \until //
-
We will now read packets from the socket forever, that is until the user hits Ctrl-C
\skip while
@@ -160,6 +164,7 @@
<a href="../../Utils/doc/html/index.html"><b>libUtils API reference</b></a>
*/
+
// Local Variables:
// mode: c++
diff --git a/Examples/SConscript b/Examples/SConscript
new file mode 100644
index 000000000..cdb256a7c
--- /dev/null
+++ b/Examples/SConscript
@@ -0,0 +1,10 @@
+import sys, glob, os.path, datetime
+sys.path.append('senfscons')
+Import('env')
+import SENFSCons
+
+###########################################################################
+
+SConscript(glob.glob("*/SConscript"))
+
+SENFSCons.Doxygen(env)
\ No newline at end of file
diff --git a/Sniffer/SConscript b/Examples/Sniffer/SConscript
similarity index 100%
rename from Sniffer/SConscript
rename to Examples/Sniffer/SConscript
diff --git a/Sniffer/Sniffer.cc b/Examples/Sniffer/Sniffer.cc
similarity index 100%
rename from Sniffer/Sniffer.cc
rename to Examples/Sniffer/Sniffer.cc
diff --git a/Mainpage.dox b/Mainpage.dox
index b4b8b00ef..3545d0b4a 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -44,7 +44,7 @@
want to contribute, read the docs and \e please adhere to the \ref conventions.
\see \ref usage\n
- \ref example
+ <a href="../../Examples/doc/html/index.html">Examples</a>
*/
/** \page usage Using the SENF framework
@@ -323,7 +323,7 @@
The simplest way to get started is: copy the Sniffer application and start to modify it.
- \see \ref example \n
+ \see <a href="../../Examples/doc/html/index.html">Examples</a> \n
\ref components \n
\ref svnsetup \n
\ref build
diff --git a/SConstruct b/SConstruct
index 4f3915c43..3d952f496 100644
--- a/SConstruct
+++ b/SConstruct
@@ -37,7 +37,7 @@ SConscript(glob.glob("*/SConscript"))
SENFSCons.StandardTargets(env)
SENFSCons.GlobalTargets(env)
SENFSCons.Doxygen(env, extra_sources = [
- 'Sniffer/Sniffer.cc',
+ 'Examples/Sniffer/Sniffer.cc',
])
SENFSCons.DoxyXRef(env,
HTML_HEADER = '#/doclib/doxy-header-overview.html',
diff --git a/doclib/doxy-header-overview.html b/doclib/doxy-header-overview.html
index 2498afbe5..9a4bf3755 100644
--- a/doclib/doxy-header-overview.html
+++ b/doclib/doxy-header-overview.html
@@ -24,6 +24,7 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
<li class="libPackets"><a href="../../Packets/doc/html/index.html">libPackets</a></li>
<li class="libScheduler"><a href="../../Scheduler/doc/html/index.html">libScheduler</a></li>
<li class="libUtils"><a href="../../Utils/doc/html/index.html">libUtils</a></li>
+ <li class="Examples"><a href="../../Examples/doc/html/index.html">Examples</a></li>
<li class="SENFSCons"><a href="../../senfscons/doc/html/index.html">SENFSCons</a></li>
</ul>
</div>
diff --git a/doclib/doxy-header.html b/doclib/doxy-header.html
index 8eab86351..b3499de5f 100644
--- a/doclib/doxy-header.html
+++ b/doclib/doxy-header.html
@@ -24,6 +24,7 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
<li class="libPackets"><a href="../../../Packets/doc/html/index.html">libPackets</a></li>
<li class="libScheduler"><a href="../../../Scheduler/doc/html/index.html">libScheduler</a></li>
<li class="libUtils"><a href="../../../Utils/doc/html/index.html">libUtils</a></li>
+ <li class="Examples"><a href="../../../Examples/doc/html/index.html">Examples</a></li>
<li class="SENFSCons"><a href="../../../senfscons/doc/html/index.html">SENFSCons</a></li>
</ul>
</div>
diff --git a/senfscons/Doxyfile b/senfscons/Doxyfile
index f76c70939..b1e9e85cc 100644
--- a/senfscons/Doxyfile
+++ b/senfscons/Doxyfile
@@ -6,3 +6,5 @@ FILE_PATTERNS = *.dox *.py
EXCLUDE_PATTERNS += __init__.py
OPTIMIZE_OUTPUT_JAVA = YES
ALPHABETICAL_INDEX = NO
+
+GENERATE_TAGFILE = doc/senfscons.tag
\ No newline at end of file
diff --git a/senfscons/Doxygen.py b/senfscons/Doxygen.py
index ea765c402..8cd35dd68 100644
--- a/senfscons/Doxygen.py
+++ b/senfscons/Doxygen.py
@@ -344,7 +344,7 @@ def DoxyGenerator(source, target, env, for_signature):
def generate(env):
"""
Add builders and construction variables for the
- Doxygen tool. This is currently for Doxygen 1.4.6.
+ Doxygen tool. This is currently for Doxygen 1.4.6.
"""
doxyfile_scanner = env.Scanner(
DoxySourceScan,
diff --git a/senfscons/Mainpage.dox b/senfscons/Mainpage.dox
index fb72ad105..7769355e7 100644
--- a/senfscons/Mainpage.dox
+++ b/senfscons/Mainpage.dox
@@ -151,9 +151,14 @@ namespace senfscons {
To configure the build environment to the local environment, a \c SConfig file may be created in
the projects root directory. The supported parameters are
- <dl><dt>\c CXX</dt><dd>C++ compiler to use</dd>
- <dt>\c EXTRA_DEFINES</dt><dd>preprocessor symbols to be defined locally</dd>
- <dt>\c EXTRA_LIBS</dt><dd>additional libraries needed for a local build</dd></dl>
+ <dl>
+ <dt>\c CXX</dt>
+ <dd>C++ compiler to use</dd>
+ <dt>\c EXTRA_DEFINES</dt>
+ <dd>preprocessor symbols to be defined locally</dd>
+ <dt>\c EXTRA_LIBS</dt>
+ <dd>additional libraries needed for a local build</dd>
+ </dl>
Additionally, the \ref use define additional configuration variables which may be set here.
*/
--
GitLab