Skip to content

Commit d256006

Browse files
kjellahlkjellahl
committed
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...)>.
1 parent 46ed128 commit d256006

File tree

9 files changed

+40
-31
lines changed

9 files changed

+40
-31
lines changed

‎sigc++/adaptors/bind.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ namespace sigc
5454
* @endcode
5555
*
5656
* The functor sigc::bind() returns can be passed into
57-
* sigc::signal::connect() directly.
57+
* @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()" directly.
5858
*
5959
* @par Example:
6060
* @code

‎sigc++/adaptors/compose.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ namespace sigc
3939
* @endcode
4040
*
4141
* The functor sigc::compose() returns can be passed directly into
42-
* sigc::signal::connect().
42+
* @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
4343
*
4444
* @par Example:
4545
* @code

‎sigc++/adaptors/exception_catch.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ namespace sigc
6262
* @endcode
6363
*
6464
* The functor sigc::exception_catch() returns can be directly passed into
65-
* sigc::signal::connect().
65+
* @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
6666
*
6767
* @par Example:
6868
* @code

‎sigc++/adaptors/hide.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ namespace sigc
5151
* @endcode
5252
*
5353
* The functor sigc::hide() returns can be directly passed into
54-
* sigc::signal::connect().
54+
* @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
5555
*
5656
* @par Example:
5757
* @code

‎sigc++/adaptors/retype.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ namespace sigc
2828
{
2929

3030
/** @defgroup retype retype(), retype_return()
31-
* sigc::retype() alters a sigc::pointer_functor, a sigc::mem_functor or a sigc::slot
31+
* sigc::retype() alters a sigc::pointer_functor, a sigc::mem_functor or
32+
* a @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
3233
* in that it makes C-style casts to the functor's parameter types
3334
* of all parameters passed through operator()().
3435
*
@@ -40,7 +41,7 @@ namespace sigc
4041
* @endcode
4142
*
4243
* The functor that sigc::retype() returns can be passed directly into
43-
* sigc::signal::connect().
44+
* @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
4445
*
4546
* @par Example:
4647
* @code
@@ -49,8 +50,9 @@ namespace sigc
4950
* some_signal.connect(sigc::retype(sigc::ptr_fun(&foo)));
5051
* @endcode
5152
*
52-
* This adaptor builds an exception in that it only works on sig::pointer_functor,
53-
* sigc::mem_functor and sigc::slot because it needs sophisticated information about
53+
* This adaptor builds an exception in that it only works on sigc::pointer_functor,
54+
* sigc::mem_functor and @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
55+
* because it needs sophisticated information about
5456
* the parameter types that cannot be deduced from arbitrary functor types.
5557
*
5658
* sigc::retype_return() alters the return type of an arbitrary functor.

‎sigc++/functors/mem_fun.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ namespace sigc
3838
* Optionally, a reference to an object can be bound to the functor.
3939
*
4040
* @note If the object type inherits from sigc::trackable, and the
41-
* functor returned from %mem_fun() is assigned to a sigc::slot, the functor
41+
* functor returned from %mem_fun() is assigned to
42+
* a @ref sigc::slot<T_return(T_arg...)> "sigc::slot", the functor
4243
* will be automatically cleared when the object goes out of scope. Invoking
4344
* that slot will then have no effect and will not try to use the destroyed
4445
* instance.

‎sigc++/functors/slot_base.h

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,8 @@ struct SIGC_API slot_do_unbind
181181
*
182182
* @section slots-creating Creating Slots
183183
*
184-
* Use the sigc::mem_fun() or sigc::ptr_fun() template functions to get a sigc::slot, like so:
184+
* Use the sigc::mem_fun() or sigc::ptr_fun() template functions to get
185+
* a @ref sigc::slot<T_return(T_arg...)> "sigc::slot", like so:
185186
* @code
186187
* sigc::slot<void(int)> sl = sigc::mem_fun(someobj, &SomeClass::somemethod);
187188
* @endcode
@@ -215,9 +216,9 @@ struct SIGC_API slot_do_unbind
215216
* auto sl = sigc::mem_fun(someobj, &SomeClass::somemethod); // Not a slot!
216217
* @endcode
217218
*
218-
* If you don't explicitly use a sigc::slot then the slot could call a method
219-
* on an instance after it has been destroyed even if the method is in a class
220-
* that derives from sigc::trackable.
219+
* If you don't explicitly use a @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
220+
* then the slot could call a method on an instance after it has been destroyed
221+
* even if the method is in a class that derives from sigc::trackable.
221222
*
222223
* @section slots-with-lambdas C++ Lambdas
223224
*
@@ -241,14 +242,14 @@ struct SIGC_API slot_do_unbind
241242
*/
242243

243244
/** Base type for slots.
244-
* slot_base integrates most of the interface of the derived
245-
* sigc::slot templates. slots
245+
* %slot_base integrates most of the interface of the derived
246+
* @ref sigc::slot<T_return(T_arg...)> "sigc::slot" template. Slots
246247
* can be connected to signals, be disconnected at some later point
247248
* (disconnect()) and temporarily be blocked (block(), unblock()).
248249
* The validity of a slot can be tested with empty().
249250
*
250251
* The internal representation of a sigc::internal::slot_rep derived
251-
* type is built from slot_base's derivations. set_parent() is used to
252+
* type is built from %slot_base's derivations. set_parent() is used to
252253
* register a notification callback that is executed when the slot gets
253254
* invalid. add_destroy_notify_callback() is used by connection objects
254255
* to add a notification callback that is executed on destruction.

‎sigc++/signal.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -543,8 +543,8 @@ class signal<T_return(T_arg...)> : public signal_with_accumulator<T_return, void
543543
public:
544544
using accumulator_type = void;
545545

546-
/** Like sigc::signal but the additional template parameter @e T_accumulator
547-
* defines the accumulator type that should be used.
546+
/** Like @ref sigc::signal<T_return(T_arg...)> "sigc::signal" but the additional
547+
* template parameter @e T_accumulator defines the accumulator type that should be used.
548548
*
549549
* An accumulator is a functor that uses a pair of special iterators
550550
* to step through a list of slots and calculate a return value

‎sigc++/signal_base.h

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -219,8 +219,8 @@ struct SIGC_API signal_impl_holder
219219
} /* namespace internal */
220220

221221
/** @defgroup signal Signals
222-
* Use sigc::signal::connect() with sigc::mem_fun() and sigc::ptr_fun() to connect a method or
223-
* function with a signal.
222+
* Use @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()"
223+
* with sigc::mem_fun() and sigc::ptr_fun() to connect a method or function with a signal.
224224
*
225225
* @code
226226
* signal_clicked.connect( sigc::mem_fun(*this, &MyWindow::on_clicked) );
@@ -232,8 +232,9 @@ struct SIGC_API signal_impl_holder
232232
* If the type of your object inherits from sigc::trackable the method is disconnected
233233
* automatically when your object is destroyed.
234234
*
235-
* When signals are copied they share the underlying information,
236-
* so you can have a protected/private sigc::signal member and a public accessor method.
235+
* When signals are copied they share the underlying information, so you can have
236+
* a protected/private @ref sigc::signal<T_return(T_arg...)> "sigc::signal"
237+
* member and a public accessor method.
237238
* A sigc::signal is a kind of reference-counting pointer. It's similar to
238239
* std::shared_ptr<>, although sigc::signal is restricted to holding a pointer to
239240
* a sigc::internal::signal_impl object that contains the implementation of the signal.
@@ -259,21 +260,25 @@ struct SIGC_API signal_impl_holder
259260
* if the given functor or closure cannot be invoked with the
260261
* parameter list of the signal to connect to.
261262
*
262-
* Almost any functor with the correct signature can be converted to a sigc::slot
263-
* and connected to a signal. See @ref slot "Slots" and sigc::signal::connect().
263+
* Almost any functor with the correct signature can be converted to
264+
* a @ref sigc::slot<T_return(T_arg...)> "sigc::slot"
265+
* and connected to a signal. See @ref slot "Slots" and
266+
* @ref sigc::signal_with_accumulator::connect() "sigc::signal::connect()".
264267
*/
265268

266-
/** Base class for the sigc::signal# templates.
267-
* signal_base integrates most of the interface of the derived sigc::signal#
268-
* templates. The implementation, however, resides in sigc::internal::signal_impl.
269-
* A sigc::internal::signal_impl object is dynamically allocated from signal_base
269+
/** Base class for the @ref sigc::signal<T_return(T_arg...)> "sigc::signal" template.
270+
* %signal_base integrates most of the interface of the derived
271+
* @ref sigc::signal<T_return(T_arg...)> "sigc::signal" template.
272+
* The implementation, however, resides in sigc::internal::signal_impl.
273+
* A sigc::internal::signal_impl object is dynamically allocated from %signal_base
270274
* when first connecting a slot to the signal. This ensures that empty signals
271275
* don't waste memory.
272276
*
273-
* sigc::internal::signal_impl is reference-counted. When a sigc::signal# object
277+
* sigc::internal::signal_impl is reference-counted.
278+
* When a @ref sigc::signal<T_return(T_arg...)> "sigc::signal" object
274279
* is copied, the reference count of its sigc::internal::signal_impl object is
275-
* incremented. Both sigc::signal# objects then refer to the same
276-
* sigc::internal::signal_impl object.
280+
* incremented. Both @ref sigc::signal<T_return(T_arg...)> "sigc::signal" objects
281+
* then refer to the same sigc::internal::signal_impl object.
277282
*
278283
* @ingroup signal
279284
*/

0 commit comments

Comments
 (0)