diff options
author | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2013-04-11 14:34:29 +0200 |
---|---|---|
committer | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2013-04-11 14:34:29 +0200 |
commit | 1e9f65c978be67da71f15231643d504e06a6af3f (patch) | |
tree | 1ee2e85bf003019235549978b0e7ea670397b548 /sigc++/sigc++.h | |
parent | e6c7220c8f2bc3d23dcfe086acc8cc9e9493c428 (diff) | |
download | sigc++-1e9f65c978be67da71f15231643d504e06a6af3f.tar.gz |
Use DOXYGEN_SHOULD_SKIP_THIS consistently.
* docs/reference/Doxyfile.in: EXTRACT_ALL=YES, like in most mm packages.
* sigc++/sigc++.h: Mention that the reference manual contains only some of
the template specializations.
* sigc++/adaptors/bound_argument.h:
* sigc++/adaptors/lambda/macros/base.h.m4:
* sigc++/adaptors/lambda/macros/group.h.m4:
* sigc++/adaptors/macros/adaptor_trait.h.m4:
* sigc++/adaptors/macros/bind.h.m4:
* sigc++/adaptors/macros/bind_return.h.m4:
* sigc++/adaptors/macros/compose.h.m4:
* sigc++/adaptors/macros/deduce_result_type.h.m4:
* sigc++/adaptors/macros/exception_catch.h.m4:
* sigc++/adaptors/macros/hide.h.m4:
* sigc++/adaptors/macros/retype.h.m4:
* sigc++/adaptors/macros/retype_return.h.m4:
* sigc++/adaptors/macros/track_obj.h.m4:
* sigc++/functors/macros/functor_trait.h.m4:
* sigc++/functors/macros/mem_fun.h.m4:
* sigc++/macros/limit_reference.h.m4:
* sigc++/type_traits.h:
* sigc++/visit_each.h: Use DOXYGEN_SHOULD_SKIP_THIS to mark what Doxygen
shall not extract.
Diffstat (limited to 'sigc++/sigc++.h')
-rw-r--r-- | sigc++/sigc++.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/sigc++/sigc++.h b/sigc++/sigc++.h index 19df4f1..6cced96 100644 --- a/sigc++/sigc++.h +++ b/sigc++/sigc++.h @@ -35,7 +35,7 @@ * * See also the * <a href="http://libsigc.sourceforge.net/libsigc2/docs/manual/html/index.html">libsigc++ tutorial</a>, - * the <a href="http://libsigc.sourceforge.net/">the libsigc++ website</a>, and + * the <a href="http://libsigc.sourceforge.net/">libsigc++ website</a>, and * the <a href="http://library.gnome.org/devel/gtkmm-tutorial/unstable/chapter-signals.html">Signals appendix of the Programming with gtkmm book</a>. * * @section features Features @@ -75,6 +75,12 @@ * program_CPPFLAGS = $(LIBSIGC_CFLAGS) * program_LDADD = $(LIBSIGC_LIBS) * @endcode + * + * @section scope Scope of Documentation + * + * libsigc++ contains many template functions and template classes/structs, + * some with many specializations. This reference manual does not show all + * specializations of those templates that hardly any user will use directly. */ #include <sigc++/signal.h> |