Socket: Add short docs to internal classes

[senf.git] / senfscons / Mainpage.dox

diff --git a/senfscons/Mainpage.dox b/senfscons/Mainpage.dox
index bcdeb27..7769355 100644 (file)
--- a/senfscons/Mainpage.dox
+++ b/senfscons/Mainpage.dox
@@ -58,7 +58,7 @@ namespace senfscons {
     <dt><tt>scons all_docs</tt></dt><dd>Build documentation of all modules</dd>
 
     <dt><tt>scons all</tt></dt><dd>Build all targets including binaries, libraries, documentation,
-    tests andpossible further targets </dd>
+    tests and possible further targets </dd>
 
     <dt><tt>scons -u doc</tt></dt><dd>Run from within a module directory will build the
     documentation of that module</dd>
@@ -84,7 +84,7 @@ namespace senfscons {
     invokes the module \c SConscript files. To simplify the configuration, the SENFScons python
     package is provided. This package has helper utilities to simplify standard tasks.
 
-    In \c senfscons/SConstruct.tempalte you may find an example SConstruct file. Copy this to the
+    In \c senfscons/SConstruct.template you may find an example SConstruct file. Copy this to the
     project root (under the name \c SConstruct) to start a new project. You can then modify and
     configure it to your wishes.
 
@@ -106,7 +106,7 @@ namespace senfscons {
     and have a prefix of \c Use. See \ref use.
 
     After all frameworks are configured, you can use SEFNScons.MakeEnvironment() to create a
-    corretly configured construction environment.
+    correctly configured construction environment.
 
     To <i>configure the construction environment</i> you can set Variables in the construction
     environment. See the SCons manpage for a list of supported variables. Some additional variables
@@ -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.
  */