Skip to content

Commit bcf2065

Browse files
committed
slot, signal: Fix the Doxygen documentation
Hide the forward declarations of sigc::slot and sigc::signal from Doxygen. If Doxygen sees the forward declarations, it does not care about what's in the complete class definitions.
1 parent e4dfe2a commit bcf2065

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

sigc++/functors/slot.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,10 @@ struct slot_call
190190
*
191191
* @ingroup slot
192192
*/
193+
#ifndef DOXYGEN_SHOULD_SKIP_THIS
193194
template <typename T_return, typename... T_arg>
194195
class slot;
196+
#endif // DOXYGEN_SHOULD_SKIP_THIS
195197

196198
template <typename T_return, typename... T_arg>
197199
class slot<T_return(T_arg...)> : public slot_base

sigc++/signal.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -529,8 +529,10 @@ class signal_with_accumulator : public signal_base
529529
*
530530
* @ingroup signal
531531
*/
532+
#ifndef DOXYGEN_SHOULD_SKIP_THIS
532533
template <typename T_return, typename... T_arg>
533534
class signal;
535+
#endif // DOXYGEN_SHOULD_SKIP_THIS
534536

535537
template <typename T_return, typename... T_arg>
536538
class signal<T_return(T_arg...)> : public signal_with_accumulator<T_return, void, T_arg...>

0 commit comments

Comments
 (0)