From: tho Date: Fri, 23 Mar 2007 12:17:53 +0000 (+0000) Subject: moved Sniffer into new Examples directory X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=9a988902090d28007578e93bffd809f6bd913155;p=senf.git moved Sniffer into new Examples directory git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@221 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Doxyfile b/Doxyfile index 8b758e1..d29688f 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 0000000..1cfe419 --- /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 eb5a816..2bd029c 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 @@ libUtils API reference */ + // Local Variables: // mode: c++ diff --git a/Examples/SConscript b/Examples/SConscript new file mode 100644 index 0000000..cdb256a --- /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 b4b8b00..3545d0b 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 + Examples */ /** \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 Examples \n \ref components \n \ref svnsetup \n \ref build diff --git a/SConstruct b/SConstruct index 4f3915c..3d952f4 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 2498afb..9a4bf37 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; }
  • libPackets
  • libScheduler
  • libUtils
    • +
  • Examples
  • SENFSCons
    • diff --git a/doclib/doxy-header.html b/doclib/doxy-header.html index 8eab863..b3499de 100644 --- a/doclib/doxy-header.html +++ b/doclib/doxy-header.html @@ -24,6 +24,7 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
  • libPackets
  • libScheduler
  • libUtils
    • +
  • Examples
  • SENFSCons
    • diff --git a/senfscons/Doxyfile b/senfscons/Doxyfile index f76c709..b1e9e85 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 ea765c4..8cd35dd 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 fb72ad1..7769355 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 -
    \c CXX
    C++ compiler to use
    -
    \c EXTRA_DEFINES
    preprocessor symbols to be defined locally
    -
    \c EXTRA_LIBS
    additional libraries needed for a local build
    +
    +
    \c CXX
    +
    C++ compiler to use
    +
    \c EXTRA_DEFINES
    +
    preprocessor symbols to be defined locally
    +
    \c EXTRA_LIBS
    +
    additional libraries needed for a local build
    +
    Additionally, the \ref use define additional configuration variables which may be set here. */