From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Wed, 9 Jul 2008 21:16:11 +0000 (+0000)
Subject: Utils: More documentation
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=93927801b67767dcce0c7490cacde9f82946f089;p=senf.git

Utils: More documentation

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@893 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/Utils/Mainpage.dox b/Utils/Mainpage.dox
index 3c0c53f..fe6dd74 100644
--- a/Utils/Mainpage.dox
+++ b/Utils/Mainpage.dox
@@ -47,6 +47,8 @@ namespace senf {
     <tr><td>\ref boost_parameter</td><td>Utilities concerning the <a
     href="http://www.boost.org/doc/libs/1_33_1/libs/parameter/doc/html/index.html">Boost.Parameter</a>
     library</td></tr>
+
+    <tr><td>\ref phoenix_helpers</td><td>Phoenix functors</td></tr>
     </table>
 
 
@@ -108,6 +110,8 @@ namespace senf {
 
     <tr><td>\ref backtraces</td><td>Utilities to parse and format backtrace information as provided
     by the GNU libc</td></tr>
+
+    <tr><td>signalName()</td><td>convert signal number to string representation</td></tr>
     </table>
 
 
diff --git a/Utils/Phoenix.hh b/Utils/Phoenix.hh
index c0e81e5..5e04362 100644
--- a/Utils/Phoenix.hh
+++ b/Utils/Phoenix.hh
@@ -33,10 +33,25 @@
 #include "Phoenix.ih"
 ///////////////////////////////hh.p////////////////////////////////////////
 
+/** \defgroup phoenix_helpers Boost.Phoenix extensions */
+
 namespace senf {
 namespace phoenix {
+    
+    /** \brief \c push_back phoenix functor
+
+        <tt>push_back(c, x) := c.push_back(x)</tt>
 
+        \ingroup phoenix_helpers
+     */
     ::phoenix::function<detail::push_back> const push_back;
+
+    /** \brief \c clear phoenix functor
+
+        <tt>clear(c) := c.clear()</tt>
+
+        \ingroup phoenix_helpers
+     */
     ::phoenix::function<detail::clear>     const clear;
 
 }}
diff --git a/Utils/signalnames.hh b/Utils/signalnames.hh
index d052e86..ecfbe4e 100644
--- a/Utils/signalnames.hh
+++ b/Utils/signalnames.hh
@@ -34,6 +34,7 @@
 
 namespace senf {
 
+    /** \brief Convert signal number to signal name */
     std::string const & signalName(int signal);
 
 }