\section senfutil_overview Building Projects using SENF
- When building projects using senf, SENFSCons has a very simple helper module \ref senfutil to
- make the building of libraries utilizing senf simpler.
+ When building projects using %senf, SENFSCons has a very simple helper module
+ \ref senf_senfutil "senfutil.py" to make the building of libraries utilizing %senf simpler.
\see \ref senf_senfutil
*/
The \c senfutil.Doxygen utility autogenerates a \c Doxyfile.
- The utility will search for a SENF documentation in the \c senfdoc and \c senf subdirectories as
- well as via the senfutil module directory and some other standard locations. If SENF
- documentation is found, the SENF tagfiles will automatically be added. Links will be resolved to
- the documentation found.
+ The utility will search for a SENF documentation in the \c senfdoc and \c %senf subdirectories
+ as well as via the senfutil module directory and some other standard locations. If SENF
+ documentation is found, the SENF tagfiles will automatically be added. Links will be resolved
+ to the documentation found.
\c senfutil.Doxygen takes some additional optional keyword arguments:
\li \c doxyheader: Path of an alternative HTML header
\li The \c xsltproc XSLT processor (http://xmlsoft.org/XSLT/xsltproc2.html)
\li The \c graphviz library (http://www.graphviz.org)
-
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)
$ 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).
+ 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 senf_setup Setting up a new project using SENF