From 89e5f0144b112213349d343cd68892754163d303 Mon Sep 17 00:00:00 2001
From: g0dil <g0dil@wiback.org>
Date: Wed, 9 Jul 2008 21:16:11 +0000
Subject: [PATCH] Utils: More documentation
---
Utils/Mainpage.dox | 4 ++++
Utils/Phoenix.hh | 15 +++++++++++++++
Utils/signalnames.hh | 1 +
3 files changed, 20 insertions(+)
diff --git a/Utils/Mainpage.dox b/Utils/Mainpage.dox
index 3c0c53f78..fe6dd7469 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 c0e81e5bf..5e0436215 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 d052e86b3..ecfbe4eee 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);
}
--
GitLab