[libsigcplusplus] slot: Update the Doxygen comment.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libsigcplusplus] slot: Update the Doxygen comment.
- Date: Fri, 11 Mar 2016 10:12:52 +0000 (UTC)
commit f6c94128cbe1cd3d02ffb035c3741d12a105d809
Author: Murray Cumming <murrayc murrayc com>
Date: Fri Mar 11 10:19:42 2016 +0100
slot: Update the Doxygen comment.
sigc++/functors/slot.h | 14 +++++++++-----
1 files changed, 9 insertions(+), 5 deletions(-)
---
diff --git a/sigc++/functors/slot.h b/sigc++/functors/slot.h
index 3ada878..ab39a97 100644
--- a/sigc++/functors/slot.h
+++ b/sigc++/functors/slot.h
@@ -129,22 +129,26 @@ struct slot_call
// slot's specialization of the visitor struct.
/** Converts an arbitrary functor to a unified type which is opaque.
- * sigc::slot itself is a functor or to be more precise a closure. It contains
+ * sigc::slot itself is a functor or, to be more precise, a closure. It contains
* a single, arbitrary functor (or closure) that is executed in operator()().
*
* The template arguments determine the function signature of operator()():
* - @e T_return The return type of operator()().
* - @e T_arg Argument types used in the definition of operator()().
*
- * To use simply assign the desired functor to the slot. If the functor
+ * For instance, to declare a slot that returns void and takes two parameters
+ * of bool and int:
+ * @code
+ * sigc::slot<void, bool, int> some_slot;
+ * @endcode
+ *
+ * To use, simply assign the desired functor to the slot. If the functor
* is not compatible with the parameter list defined with the template
- * arguments compiler errors are triggered. When called the slot
+ * arguments then compiler errors are triggered. When called, the slot
* will invoke the functor with minimal copies.
* block() and unblock() can be used to block the functor's invocation
* from operator()() temporarily.
*
- * You should use the more convenient unnumbered sigc::slot template.
- *
* @ingroup slot
*/
template <class T_return, class... T_arg>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]