Skip to content
Snippets Groups Projects
Commit d6225144 authored by g0dil's avatar g0dil
Browse files

Documentation updates

parent 724be1b6
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 310 additions and 90 deletions
Doxyfile
+ 2
− 2
View file @ d6225144
PROJECT_NAME = Overview
PROJECT_NUMBER = "Version 0.0.1"
PROJECT_NUMBER =
OUTPUT_DIRECTORY = doc
CREATE_SUBDIRS = NO
......@@ -71,7 +71,7 @@ FILE_PATTERNS = *.dox
RECURSIVE = NO
EXCLUDE = doc
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = *~ .#*
EXCLUDE_PATTERNS = .*
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
......
Mainpage.dox
+ 193
− 20
View file @ d6225144
......@@ -9,7 +9,7 @@
\section Goals
The main goals where (in no particular order)
The main goals of this library are (in no particular order):
\li modular framework design
\li utilizing the power of modern C++
......@@ -17,13 +17,124 @@
\li extensible design
\li concise interface
\section Components
\section start Getting started
To get started using this library, begin by checking out the code
from the <a
href="http://developer.berlios.de/svn/?group_id=7489">BerliOS SVN
repository</a>. You may find help on using the library at '\ref
usage'. If you are interested in SENF, feel free to subscribe
to the <a
href="http://developer.berlios.de/mail/?group_id=7489">SENF
mailing lists</a>.
\see \ref usage\n
\ref example\n
<a href="http://developer.berlios.de/projects/senf"><b><i>The BerliOS project page</i></b></a>\n
<a href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework"><b><i>The SENF Wiki at BerliOS</i></b></a>
*/
/** \page usage Using the SENF framework
The SENF Framework is a collection of lossly coupled
modules. The libraries are heavily object oriented and template
based. For compatibility reasons, the libraries are therefore
built together with every project making use of the framework.
When starting a new Projekt based on the SENF framework, it is
advisable, to make use of the SENFSCons build environment and use
SVN to manage the code repository. This is the configuration,
described in this documentation.
\see \ref build \n
\ref components \n
\ref svnsetup
\section Preliminaries
Before starting the devlopment, make sure to fulfill the following
requirements:
\li GNU g++, version at least 3.4
\li The Boost libraries (http://www.boost.org)
\li The SCons build tool (http://www.scons.org)
If you want to build the documentation, you additionally need
\li Doxygen (http://www.doxygen.org)
\li The \c dia diagram editor (http://www.gnome.org/projects/dia/)
The library is only tested with gcc-3.4 and 4.0 on Linux. On other
POSIX platforms with a BSD Socket API, the library should be
usable, possibly with some tweaking (except for the Scheduler,
which relies on \c epoll)
\todo
\li Preliminaries: SVN access, Dependencies
\li Building the library -> Configuration
\li Setting up a project using this library (svn:externals)
\li Library components
\li coding standards and patterns
*/
/** \page build Building the framework
This procedure will test building the complete framework
including the unit tests and the Sniffer test application. This
build is \e not needed to use the framework since every project
will include the full SENF source code itself (via Subversion).
After you have successfully built the library tests, you can
continue to setup your own project using SENF.
\see \ref components \n
\ref svnsetup
\section checkout Getting the code
To access the code, check out the code from the BerliOS
repository. Change to your development directory and use the
following subversion command
<pre class="fragment">
$ svn checkout http://svn.berlios.de/svnroot/repos/senf/trunk senf</pre>
This will create a new directory \c senf within the current
directory. For further documentation on the use of Subversion, see
the \c svn manpage or the subversion homepage at
http://subversion.tigris.org. A very good introduction and
reference to subversion is available at
http://svnbook.red-bean.com.
\section compile Building
To build the library, execute all unit tests and build the Sniffer
test application, use
<pre class="fragment">
$ scons
$ scons all_tests</pre>
in the \c senf directory. This assumes, that you want to build the
library with your default gcc and requires the boost libraries to
be available in the system include paths. If this is not the case,
you can take a look at <tt>SConfig.template</tt> file. Copy this
file to <tt>SConfig</tt> and comment out all the variables you
don't want to change (The \e values in the template file are just
arbitrary examples).
*/
/** \page components The SENF modules
The framework is made up of several modular components. When using
the library, it is possible to selectively choose to use only a
subset of the implemented modules. The modules are
subset of the implemented modules.
\see \ref build \n
\ref svnsetup
\subsection libSocket libSocket: C++ abstraction of the BSD socket API
\section libSocket libSocket: C++ abstraction of the BSD socket API
This library provides a high performance and object oriented
abstraction of the standard socket API. It utilizes a flexible and
......@@ -34,7 +145,7 @@
\see <a href="../../Socket/doc/html/index.html">libSocket API
reference</a>
\subsection libPackets libPackets: Network packet manipulation
\section libPackets libPackets: Network packet manipulation
This libarary provides a very flexible infrastructure to
parse, create and otherwise manipulate packetized network
......@@ -45,7 +156,7 @@
\see <a href="../../Packets/doc/html/index.html">libPackets API
reference</a>
\subsection libScheduler libScheduler: Asynchronous event handling
\section libScheduler libScheduler: Asynchronous event handling
The scheduler library provides an object oriented interface to the
standard UNIX \c select type event dispatcher. It is based on the
......@@ -55,7 +166,7 @@
\see <a href="../../Scheduler/doc/html/index.html">libScheduler API
reference</a>
\subsection libUtils libUtils: Collection of arbitrary utilities
\section libUtils libUtils: Collection of arbitrary utilities
This library is used be most all of the other modules for
miscellaneous tools and utilities. We have
......@@ -72,6 +183,80 @@
\see <a href="../../Utils/doc/html/index.html">libUtils API
reference</a>
\section senfscons SENFSCons, the SENF build environment
SENF relies on SCons (http://www.scons.org) to build. To further
simplify the common tasks, SENF includes a library of custom
routines and builders comprising a very concise build
environment. Included are a number of templates to help
bootstrapping a new project or component.
\see <a href="../../satscons/doc/html/index.html">SENFSCons
reference</a>
*/
/** \page svnsetup Setting up a new project using SENF via SVN
The preferred way to use SENF in a new project is to rely on
Subversion and make use of the SENFSCons build environment. The
following sections will describe, how this setup works.
\section svnext Setting up the project repository
The most seamless integration is possible if you rely on
Subversion to manage the new project. Subversion does support
'external repositories'. This allows to import code from a foreign
repository into the checkout without importing it into your
repository. The code will always stay at the remote repository,
updates are automatically available.
First setup a new empty repository as described for example in the
Subversion book at http://svnbook.red-bean.com or as mandated by
your site policy. We will call the project 'Foo' and assume, that
the project has been checked out into the 'Foo' directory.
You now have to decide, which modules you want to use. Every
module resides in it's own subdirectory in the SENF
repository. Instead of directly checking out the code, we will use
\c svn:externals. This will instruct \c svn to auutomatically
check out the needed directories from the BerliOS SENF
repository. Change to the 'Foo' directory and type
<pre class="fragment">
$ svn propedit svn:externals .</pre>
The default editor (probably VI) will be started with the current
value of the svn:externals property (which will probably be
empty). Now add all the modules you want plus \c satscons and
possibly \c doclib (if you want to build the documentation). You
will almost certainly neeed the \c Utils module, since all other
modules depend on it.
For example, if you want to use the \c Scheduler and \c Socket
module, the file will look like
<pre class="fragment">
satscons http://svn.berlios.de/svnroot/repos/senf/trunk/satscons
Utils http://svn.berlios.de/svnroot/repos/senf/trunk/Utils
Scheduler http://svn.berlios.de/svnroot/repos/senf/trunk/Scheduler
Socket http://svn.berlios.de/svnroot/repos/senf/trunk/Socket</pre>
exit the editor and the property will be set. Now run
<pre class="fragment">
$ svn update</pre>
and the code will be checked out into the corresponding
directories.
\todo \li Configuring and building -> reference to the SENFSCons
dok
*/
/** \page example Sniffer: A simple Example application
*/
\section code Coding practices
The library heavily depends on the features of modern C++. As
......@@ -90,20 +275,8 @@
designed with standardization in mind. Many of the libraries are
already in queue to be part of the next generation C++ standard.
\section Dependencies
\li A standards compliant, modern C++ compiler. The library as
such is developed under Linux using \c gcc with Version
above 3.4
\li The Boost libraries from http://www.boost.org
\li The SCons build tool (see http://www.scons.org)
\li Linux. The library only makes use of the POSIX API's, however
it has not been tested beyond Linux, so if you are somewhere
else, you are on your own. However, we will greatly appreciate
feedback and patches for other platforms.
*/
// Local Variables:
// mode: c++
// End:
SConstruct
+ 0
− 2
View file @ d6225144
......@@ -8,9 +8,7 @@ import SatSCons
SatSCons.UseBoost()
SatSCons.UseSTLPort()
SatSCons.UseDoxygen()
env = SatSCons.MakeEnvironment()
env.Tool('Dia2Png', [ 'satscons' ])
env.Append(
CPPPATH = [ '#' ],
......
doclib/Doxyfile.global
+ 1
− 1
View file @ d6225144
......@@ -83,7 +83,7 @@ FILE_PATTERNS = *.c *.cc *.cci *.ct *.cti *.h *.hh *.ih *.mmc *.dox
RECURSIVE = NO
EXCLUDE = doc
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = *.test.cc *~ .#*
EXCLUDE_PATTERNS = *.test.cc *~ .*
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
......
doclib/doxy-footer.html
+ 11
− 1
View file @ d6225144
</div></body></html>
<hr style="border: none; clear: both" />
</div>
</div>
<div id="footer">
<span>
<a href="todo.html">Todo</a> |
<a href="mailto:senf-dev@lists.berlios.de">Contact: senf-dev@lists.berlios.de</a> |
Copyright &copy; 2006 Fraunhofer Gesellschft, SatCom, Stefan Bund
</span>
</div>
</body></html>
doclib/doxy-header-overview.html
+ 14
− 12
View file @ d6225144
......@@ -12,18 +12,20 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
<div id="head">
<h1>SENF Extensible Network Framework</h1>
<h2>SENF Framework API reference</h2>
<h2>Introduction and Overview</h2>
</div>
<div id="content">
<div class="tabs">
<ul>
<li class="Overview"><a href="../../doc/html/index.html"><i>Overview</i></a></li>
<li><a href="http://senf.berlios.de"><i>SENF @ BerliOS</i></a></li>
<div id="content1">
<div id="content2">
<div class="tabs">
<ul>
<li class="Overview"><a href="../../doc/html/index.html"><i>Overview</i></a></li>
<li><a href="http://developer.berlios.de/projects/senf"><i>SENF @ BerliOS</i></a></li>
<li class="libSocket"><a href="../../Socket/doc/html/index.html">libSocket</a></li>
<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>
</ul>
</div>
<li class="libSocket"><a href="../../Socket/doc/html/index.html">libSocket</a></li>
<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="SENFSCons"><a href="../../satscons/doc/html/index.html">SENFSCons</a></li>
</ul>
</div>
doclib/doxy-header.html
+ 14
− 12
View file @ d6225144
......@@ -12,18 +12,20 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
<div id="head">
<h1>SENF Extensible Network Framework</h1>
<h2>SENF Framework API reference</h2>
<h2>Documentation and API reference</h2>
</div>
<div id="content">
<div class="tabs">
<ul>
<li class="Overview"><a href="../../../doc/html/index.html"><i>Overview</i></a></li>
<li><a href="http://senf.berlios.de"><i>SENF @ BerliOS</i></a></li>
<div id="content1">
<div id="content2">
<div class="tabs">
<ul>
<li class="Overview"><a href="../../../doc/html/index.html"><i>Overview</i></a></li>
<li><a href="http://developer.berlios.de/projects/senf"><i>SENF @ BerliOS</i></a></li>
<li class="libSocket"><a href="../../../Socket/doc/html/index.html">libSocket</a></li>
<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>
</ul>
</div>
<li class="libSocket"><a href="../../../Socket/doc/html/index.html">libSocket</a></li>
<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="SENFSCons"><a href="../../../satscons/doc/html/index.html">SENFSCons</a></li>
</ul>
</div>
doclib/senf.css
+ 33
− 5
View file @ d6225144
......@@ -30,15 +30,20 @@ body {
padding: 4px 0 0 0;
height: 18px;
background-color: #EDE497;
color: #726921;
font-size: 13px;
font-weight: normal;
color: #726921;
white-space: nowrap;
}
#content {
/* Non-0 top padding to fix margin inhertance from first non-float elt */
padding: 1px 10px 10px 142px;
#content1 {
padding: 0 10px 10px 142px;
border-bottom: 1px solid #AF9D00;
}
#content2 {
/* need non-zero top padding here to prevent margin propagation */
padding: 10px 0 0 0;
max-width: 60em;
}
......@@ -48,7 +53,7 @@ div.tabs {
clear: left;
background-color: #FDF7C3;
border: 1px solid #AF9D00;
margin: 10px 0 0 -132px;
margin: 0 0 10px -132px;
width: 120px;
overflow: hidden;
}
......@@ -101,3 +106,26 @@ div.qindex {
padding: 2px;
line-height: 140%;
}
#footer {
clear: both;
padding: 4px 10px 4px 142px;
color: #726921;
white-space: nowrap;
text-align: right;
max-width: 60em;
}
#footer span {
font-size: 10px;
}
#footer a, #footer a:active, #footer a:visited {
color: #726921;
text-decoration: none;
}
#footer a:hover {
background-color: inherit;
text-decoration: underline;
}
\ No newline at end of file
satscons/Doxyfile 0 → 100644
+ 4
− 0
View file @ d6225144
PROJECT_NAME = SENFSCons
PROJECT_NUMBER = "Version 0.0.1"
@INCLUDE = ../doclib/Doxyfile.global
\ No newline at end of file
satscons/Doxygen.py
+ 20
− 28
View file @ d6225144
......@@ -81,12 +81,11 @@ def DoxyfileParse(file_contents, dir, data = None):
# compress lists of len 1 into single strings
for (k, v) in data.items():
if k == "@INCLUDE" : continue
if len(v) == 0:
data.pop(k)
# items in the following list will be kept as lists and not converted to strings
if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS"]:
if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS", "@INCLUDE", "TAGFILES"]:
continue
if len(v) == 1:
......@@ -101,6 +100,10 @@ def DoxySourceScan(node, env, path):
Doxygen Doxyfile source scanner. This should scan the Doxygen file and add
any files used to generate docs to the list of source files.
"""
dep_add_keys = [
'@INCLUDE', 'HTML_HEADER', 'HTML_FOOTER', 'TAGFILES'
]
default_file_patterns = [
'*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx',
'*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++',
......@@ -112,45 +115,34 @@ def DoxySourceScan(node, env, path):
'*~',
]
sources = []
data = DoxyfileParse(node.get_contents(), str(node.dir))
if data.get("RECURSIVE", "NO") == "YES":
recursive = True
else:
recursive = False
file_patterns = data.get("FILE_PATTERNS", default_file_patterns)
sources = []
basedir = str(node.dir)
data = DoxyfileParse(node.get_contents(), basedir)
recursive = ( data.get("RECURSIVE", "NO") == "YES" )
file_patterns = data.get("FILE_PATTERNS", default_file_patterns)
exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns)
for i in data.get("INPUT", [ "." ]):
input = os.path.normpath(os.path.join(str(node.dir),i))
input = os.path.normpath(os.path.join(basedir,i))
if os.path.isfile(input):
sources.append(input)
elif os.path.isdir(input):
if recursive:
entries = os.walk(input)
else:
entries = [ (input, [], os.listdir(input)) ]
if recursive : entries = os.walk(input)
else : entries = [ (input, [], os.listdir(input)) ]
for root, dirs, files in entries:
for f in files:
filename = os.path.join(root, f)
pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False)
exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True)
if pattern_check and not exclude_check:
filename = os.path.normpath(os.path.join(root, f))
if ( reduce(lambda x, y: x or fnmatch(filename, y),
file_patterns, False)
and not reduce(lambda x, y: x or fnmatch(filename, y),
exclude_patterns, False) ):
sources.append(filename)
sources.extend([ os.path.normpath(os.path.join(str(node.dir),x))
for x in data.get("@INCLUDE",[]) ])
for key in ('HTML_HEADER','HTML_FOOTER','TAGFILES'):
for key in dep_add_keys:
if data.has_key(key):
elt = data[key]
if type(elt) is type ("") : elt = [ elt ]
sources.extend([ os.path.normpath(os.path.join(str(node.dir),f))
sources.extend([ os.path.normpath(os.path.join(basedir,f))
for f in elt ])
sources = map( lambda path: env.File(path), sources )
......
satscons/SConscript 0 → 100644
+ 7
− 0
View file @ d6225144
Import('env')
import SatSCons
###########################################################################
SatSCons.StandardTargets(env)
SatSCons.Doxygen(env)
satscons/SatSCons.py
+ 11
− 7
View file @ d6225144
import os.path, SCons.Options, SCons.Environment, SCons.Script.SConscript, glob
SCONS_TOOLS = [
"Doxygen",
"Dia2Png",
]
opts = None
finalizers = []
basedir = os.path.split(__file__)[0]
def InitOpts():
global opts
if opts is not None: return
......@@ -28,7 +35,7 @@ def UseBoost():
Finalizer(FinalizeBoost)
def FinalizeBoost(env):
env.Tool('BoostUnitTests', [os.path.split(__file__)[0]])
env.Tool('BoostUnitTests', [basedir])
if env['BOOST_TOOLSET']:
runtime = ""
......@@ -64,12 +71,6 @@ def FinalizeSTLPort(env):
env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
CPPDEFINES = [ '_STLP_DEBUG' ])
def UseDoxygen():
Finalizer(FinalizeDoxygen)
def FinalizeDoxygen(env):
env.Tool('Doxygen', [os.path.split(__file__)[0]])
def MakeEnvironment():
global opts, finalizers
InitOpts()
......@@ -85,6 +86,9 @@ def MakeEnvironment():
for finalizer in finalizers:
finalizer(env)
for tool in SCONS_TOOLS:
env.Tool(tool, [basedir])
env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
LOCALLIBDIR = [ '#' ],
LIBPATH = [ '$LOCALLIBDIR' ])
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Datenschutz und Impressum