From: g0dil Date: Sun, 7 Nov 2010 22:52:12 +0000 (+0000) Subject: Some URL fixes X-Git-Url: http://g0dil.de/git?p=senf.git;a=commitdiff_plain;h=9a9248e23ad5b291f43e79c5eb530b99c6030418 Some URL fixes git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1746 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Examples/Sniffer/Mainpage.dox b/Examples/Sniffer/Mainpage.dox index 349087d..e7526bb 100644 --- a/Examples/Sniffer/Mainpage.dox +++ b/Examples/Sniffer/Mainpage.dox @@ -176,9 +176,9 @@ \see \ref senf_components \n \ref senf_build \n - libSocket API reference \n - libPackets API reference \n - libUtils API reference + libSocket API reference \n + libPackets API reference \n + libUtils API reference */ diff --git a/doclib/Mainpage.dox b/doclib/Mainpage.dox index 1a34f47..72d5142 100644 --- a/doclib/Mainpage.dox +++ b/doclib/Mainpage.dox @@ -459,12 +459,6 @@ When building against a self-built SENF which will probably be in debug mode, the '-DSENF_DEBUG' option must be added to the compile command. - The most simple way to build using SENF is to use a very simple SCons helper which automatically - supports debug and final builds, uses SENF either centrally installed or locally built and has - some other nice features. See Building Projects using SENF - for more info and an example for this utility. - \see \ref senf_components \n \ref senf_overview */ @@ -482,7 +476,7 @@ oriented network applications. The library provides a large set of pre-defined modules as well as the necessary helpers to implement application specific processing modules. - \see libPPI API reference + \see libPPI API reference \section libSocket libSocket: C++ abstraction of the BSD socket API @@ -490,7 +484,7 @@ API. It utilizes a flexible and extensible policy based design. The library provides predefined types for the important socket types (UDP and TCP sockets etc) including raw and packet sockets. - \see libSocket API reference + \see libSocket API reference \section libPackets libPackets: Network packet manipulation @@ -498,7 +492,7 @@ packetized network data. Included is a library of several protocol parsers covering the basic IPv4 and IPv6 network protocols down to the Ethernet layer. - \see libPackets API reference + \see libPackets API reference \section libScheduler libScheduler: Asynchronous event handling @@ -506,7 +500,7 @@ event dispatcher. It is based on the high performance \c epoll system call. It provides support for read/write events as well as simple timer based events. - \see libScheduler API reference + \see libScheduler API reference \section libUtils libUtils: Collection of arbitrary utilities @@ -521,7 +515,7 @@ \li An interface to the \c g++ de-mangler integrated with type_info \li Typedefs and rudimentary methods to simplify handling high-resolution time values - \see libUtils API reference + \see libUtils API reference \section senfscons SENFSCons, the SENF build environment @@ -552,23 +546,24 @@ \section senf_startup Getting starting developing with SENF To introduce the framework and it's general structure, a simple example application is provided - in the SENF repository in the \c Sniffer module. Peruse this example to get a first look at how + in the SENF repository in the \c %Sniffer module. Peruse this example to get a first look at how to make use of SENF. When building a network Application with SENF, you will use several modules: - \li Use the Socket library for network + \li Use the Socket library for network communication needs. This library includes support for raw and packet sockets to allow low level network access. - \li Use the Scheduler library to coordinate - the asynchronous event processing. This drastically reduces the number of threads needed in - your application and will greatly enhance the overall responsiveness. + \li Use the Scheduler library to + coordinate the asynchronous event processing. This drastically reduces the number of threads + needed in your application and will greatly enhance the overall responsiveness. \li To interpret low level network packets, use the Packets library. This library will provide + href="../../senf/Packets/doc/html/index.html">Packets library. This library will provide efficient and convenient access to all protocol fields. It supports parsing as well as modifying and creating packets. It has default support for the most important Internet protocols and is highly extensible with new protocols. - \li Go over the Utils library. It contains small + \li Go over the Utils library. It contains + small helpers to simplify tasks like daemonization, exception handling, debugging and so on. The simplest way to get started is: copy the Sniffer application and start to modify it. diff --git a/senf/PPI/Mainpage.dox b/senf/PPI/Mainpage.dox index 51ddf52..dca7b8c 100644 --- a/senf/PPI/Mainpage.dox +++ b/senf/PPI/Mainpage.dox @@ -64,10 +64,10 @@ \section ppi_packets Packets - The PPI processes packets and uses the Packet - library to handle them. All packets are internally passed around as generic \ref - senf::Packet references, however connectors may optionally be defined as sending or receiving - packets of a specific type only. + The PPI processes packets and uses the Packet library to handle them. All packets + are internally passed around as generic \ref senf::Packet references, however connectors may + optionally be defined as sending or receiving packets of a specific type only. \section ppi_modules Modules @@ -324,7 +324,7 @@ The PPI really is not concerned, how the events are called and what information is needed to perform the call. This is handled by the Scheduler, which is wrapped by the event + href="@TOPDIR@/senf/Scheduler/doc/html/index.html">Scheduler, which is wrapped by the event classes. All events are derived from senf::ppi::EventDescriptor. The base class allows to enable and diff --git a/senf/Packets/Mainpage.dox b/senf/Packets/Mainpage.dox index c428f21..430ccf6 100644 --- a/senf/Packets/Mainpage.dox +++ b/senf/Packets/Mainpage.dox @@ -758,7 +758,7 @@ \autotoc - \see NewPacket HowTo + \see NewPacket HowTo \section packet_new_parser The protocol parser