summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKjell Ahlstedt <kjellahlstedt@gmail.com>2021-12-29 15:17:12 +0100
committerKjell Ahlstedt <kjellahlstedt@gmail.com>2021-12-29 15:17:12 +0100
commitd256006bab41a0c30b6955df8f35efaecd64ef26 (patch)
tree3a50350f2bd0e035767e2bdc8691869ea5f65576
parent46ed1289e98d562ae85fc3a60a246ea2ef5e9e9d (diff)
downloadsigc++-d256006bab41a0c30b6955df8f35efaecd64ef26.tar.gz
docs: Fix links to sigc::slot and sigc::signal
Doxygen creates links to sigc::slot and sigc::signal only if template parameters are included in the documentation. sigc::slot<T_return(T_arg...)>, sigc::signal<T_return(T_arg...)>.
-rw-r--r--sigc++/adaptors/bind.h2
-rw-r--r--sigc++/adaptors/compose.h2
-rw-r--r--sigc++/adaptors/exception_catch.h2
-rw-r--r--sigc++/adaptors/hide.h2
-rw-r--r--sigc++/adaptors/retype.h10
-rw-r--r--sigc++/functors/mem_fun.h3
-rw-r--r--sigc++/functors/slot_base.h15
-rw-r--r--sigc++/signal.h4
-rw-r--r--sigc++/signal_base.h31
9 files changed, 40 insertions, 31 deletions
diff --git a/sigc++/adaptors/bind.h b/sigc++/adaptors/bind.h
index 1d89ba0..1d48383 100644
--- a/sigc++/adaptors/bind.h
+++ b/sigc++/adaptors/bind.h
@@ -54,7 +54,7 @@ namespace sigc
* @endcode
*
* The functor sigc::bind() returns can be passed into
- * sigc::signal::connect() directly.
+ * @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()" directly.
*
* @par Example:
* @code
diff --git a/sigc++/adaptors/compose.h b/sigc++/adaptors/compose.h
index 3fadceb..10f948c 100644
--- a/sigc++/adaptors/compose.h
+++ b/sigc++/adaptors/compose.h
@@ -39,7 +39,7 @@ namespace sigc
* @endcode
*
* The functor sigc::compose() returns can be passed directly into
- * sigc::signal::connect().
+ * @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
*
* @par Example:
* @code
diff --git a/sigc++/adaptors/exception_catch.h b/sigc++/adaptors/exception_catch.h
index a7ccf9a..f1dae2e 100644
--- a/sigc++/adaptors/exception_catch.h
+++ b/sigc++/adaptors/exception_catch.h
@@ -62,7 +62,7 @@ namespace sigc
* @endcode
*
* The functor sigc::exception_catch() returns can be directly passed into
- * sigc::signal::connect().
+ * @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
*
* @par Example:
* @code
diff --git a/sigc++/adaptors/hide.h b/sigc++/adaptors/hide.h
index ac8a1a0..46bc5d3 100644
--- a/sigc++/adaptors/hide.h
+++ b/sigc++/adaptors/hide.h
@@ -51,7 +51,7 @@ namespace sigc
* @endcode
*
* The functor sigc::hide() returns can be directly passed into
- * sigc::signal::connect().
+ * @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
*
* @par Example:
* @code
diff --git a/sigc++/adaptors/retype.h b/sigc++/adaptors/retype.h
index 948fe5c..ce2adcd 100644
--- a/sigc++/adaptors/retype.h
+++ b/sigc++/adaptors/retype.h
@@ -28,7 +28,8 @@ namespace sigc
{
/** @defgroup retype retype(), retype_return()
- * sigc::retype() alters a sigc::pointer_functor, a sigc::mem_functor or a sigc::slot
+ * sigc::retype() alters a sigc::pointer_functor, a sigc::mem_functor or
+ * a @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
* in that it makes C-style casts to the functor's parameter types
* of all parameters passed through operator()().
*
@@ -40,7 +41,7 @@ namespace sigc
* @endcode
*
* The functor that sigc::retype() returns can be passed directly into
- * sigc::signal::connect().
+ * @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
*
* @par Example:
* @code
@@ -49,8 +50,9 @@ namespace sigc
* some_signal.connect(sigc::retype(sigc::ptr_fun(&foo)));
* @endcode
*
- * This adaptor builds an exception in that it only works on sig::pointer_functor,
- * sigc::mem_functor and sigc::slot because it needs sophisticated information about
+ * This adaptor builds an exception in that it only works on sigc::pointer_functor,
+ * sigc::mem_functor and @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
+ * because it needs sophisticated information about
* the parameter types that cannot be deduced from arbitrary functor types.
*
* sigc::retype_return() alters the return type of an arbitrary functor.
diff --git a/sigc++/functors/mem_fun.h b/sigc++/functors/mem_fun.h
index 44e80e9..2071752 100644
--- a/sigc++/functors/mem_fun.h
+++ b/sigc++/functors/mem_fun.h
@@ -38,7 +38,8 @@ namespace sigc
* Optionally, a reference to an object can be bound to the functor.
*
* @note If the object type inherits from sigc::trackable, and the
- * functor returned from %mem_fun() is assigned to a sigc::slot, the functor
+ * functor returned from %mem_fun() is assigned to
+ * a @ref sigc::slot<T_return(T_arg...)> "sigc::slot", the functor
* will be automatically cleared when the object goes out of scope. Invoking
* that slot will then have no effect and will not try to use the destroyed
* instance.
diff --git a/sigc++/functors/slot_base.h b/sigc++/functors/slot_base.h
index 1f7589c..bf7959a 100644
--- a/sigc++/functors/slot_base.h
+++ b/sigc++/functors/slot_base.h
@@ -181,7 +181,8 @@ struct SIGC_API slot_do_unbind
*
* @section slots-creating Creating Slots
*
- * Use the sigc::mem_fun() or sigc::ptr_fun() template functions to get a sigc::slot, like so:
+ * Use the sigc::mem_fun() or sigc::ptr_fun() template functions to get
+ * a @ref sigc::slot<T_return(T_arg...)> "sigc::slot", like so:
* @code
* sigc::slot<void(int)> sl = sigc::mem_fun(someobj, &SomeClass::somemethod);
* @endcode
@@ -215,9 +216,9 @@ struct SIGC_API slot_do_unbind
* auto sl = sigc::mem_fun(someobj, &SomeClass::somemethod); // Not a slot!
* @endcode
*
- * If you don't explicitly use a sigc::slot then the slot could call a method
- * on an instance after it has been destroyed even if the method is in a class
- * that derives from sigc::trackable.
+ * If you don't explicitly use a @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
+ * then the slot could call a method on an instance after it has been destroyed
+ * even if the method is in a class that derives from sigc::trackable.
*
* @section slots-with-lambdas C++ Lambdas
*
@@ -241,14 +242,14 @@ struct SIGC_API slot_do_unbind
*/
/** Base type for slots.
- * slot_base integrates most of the interface of the derived
- * sigc::slot templates. slots
+ * %slot_base integrates most of the interface of the derived
+ * @ref sigc::slot<T_return(T_arg...)> "sigc::slot" template. Slots
* can be connected to signals, be disconnected at some later point
* (disconnect()) and temporarily be blocked (block(), unblock()).
* The validity of a slot can be tested with empty().
*
* The internal representation of a sigc::internal::slot_rep derived
- * type is built from slot_base's derivations. set_parent() is used to
+ * type is built from %slot_base's derivations. set_parent() is used to
* register a notification callback that is executed when the slot gets
* invalid. add_destroy_notify_callback() is used by connection objects
* to add a notification callback that is executed on destruction.
diff --git a/sigc++/signal.h b/sigc++/signal.h
index c1b0f33..b8e0f26 100644
--- a/sigc++/signal.h
+++ b/sigc++/signal.h
@@ -543,8 +543,8 @@ class signal<T_return(T_arg...)> : public signal_with_accumulator<T_return, void
public:
using accumulator_type = void;
- /** Like sigc::signal but the additional template parameter @e T_accumulator
- * defines the accumulator type that should be used.
+ /** Like @ref sigc::signal<T_return(T_arg...)> "sigc::signal" but the additional
+ * template parameter @e T_accumulator defines the accumulator type that should be used.
*
* An accumulator is a functor that uses a pair of special iterators
* to step through a list of slots and calculate a return value
diff --git a/sigc++/signal_base.h b/sigc++/signal_base.h
index 647ee02..3027c69 100644
--- a/sigc++/signal_base.h
+++ b/sigc++/signal_base.h
@@ -219,8 +219,8 @@ protected:
} /* namespace internal */
/** @defgroup signal Signals
- * Use sigc::signal::connect() with sigc::mem_fun() and sigc::ptr_fun() to connect a method or
- * function with a signal.
+ * Use @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()"
+ * with sigc::mem_fun() and sigc::ptr_fun() to connect a method or function with a signal.
*
* @code
* signal_clicked.connect( sigc::mem_fun(*this, &MyWindow::on_clicked) );
@@ -232,8 +232,9 @@ protected:
* If the type of your object inherits from sigc::trackable the method is disconnected
* automatically when your object is destroyed.
*
- * When signals are copied they share the underlying information,
- * so you can have a protected/private sigc::signal member and a public accessor method.
+ * When signals are copied they share the underlying information, so you can have
+ * a protected/private @ref sigc::signal<T_return(T_arg...)> "sigc::signal"
+ * member and a public accessor method.
* A sigc::signal is a kind of reference-counting pointer. It's similar to
* std::shared_ptr<>, although sigc::signal is restricted to holding a pointer to
* a sigc::internal::signal_impl object that contains the implementation of the signal.
@@ -259,21 +260,25 @@ protected:
* if the given functor or closure cannot be invoked with the
* parameter list of the signal to connect to.
*
- * Almost any functor with the correct signature can be converted to a sigc::slot
- * and connected to a signal. See @ref slot "Slots" and sigc::signal::connect().
+ * Almost any functor with the correct signature can be converted to
+ * a @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
+ * and connected to a signal. See @ref slot "Slots" and
+ * @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
*/
-/** Base class for the sigc::signal# templates.
- * signal_base integrates most of the interface of the derived sigc::signal#
- * templates. The implementation, however, resides in sigc::internal::signal_impl.
- * A sigc::internal::signal_impl object is dynamically allocated from signal_base
+/** Base class for the @ref sigc::signal<T_return(T_arg...)> "sigc::signal" template.
+ * %signal_base integrates most of the interface of the derived
+ * @ref sigc::signal<T_return(T_arg...)> "sigc::signal" template.
+ * The implementation, however, resides in sigc::internal::signal_impl.
+ * A sigc::internal::signal_impl object is dynamically allocated from %signal_base
* when first connecting a slot to the signal. This ensures that empty signals
* don't waste memory.
*
- * sigc::internal::signal_impl is reference-counted. When a sigc::signal# object
+ * sigc::internal::signal_impl is reference-counted.
+ * When a @ref sigc::signal<T_return(T_arg...)> "sigc::signal" object
* is copied, the reference count of its sigc::internal::signal_impl object is
- * incremented. Both sigc::signal# objects then refer to the same
- * sigc::internal::signal_impl object.
+ * incremented. Both @ref sigc::signal<T_return(T_arg...)> "sigc::signal" objects
+ * then refer to the same sigc::internal::signal_impl object.
*
* @ingroup signal
*/