[libsigc++2] Document namespace sigc briefly



commit 905ea9e5233fae4bb1da8bc71128430dba162d22
Author: Daniel Elstner <danielk openismus com>
Date:   Wed Sep 2 16:32:52 2009 +0200

    Document namespace sigc briefly
    
    * sigc++/signal_base.h (sigc): Prepend documentation comment to
    provide a brief description of namespace sigc, so that Doxygen
    will recognize the namespace as documented.

 ChangeLog            |    8 ++++++++
 sigc++/signal_base.h |    2 ++
 2 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index dfa6b6d..1206417 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2009-09-02  Daniel Elstner  <danielk openismus com>
+
+	Document namespace sigc briefly
+
+	* sigc++/signal_base.h (sigc): Prepend documentation comment to
+	provide a brief description of namespace sigc, so that Doxygen
+	will recognize the namespace as documented.
+
 2009-08-31  Daniel Elstner  <danielk openismus com>
 
 	Update Doxygen configuration for Doxygen 1.6.1
diff --git a/sigc++/signal_base.h b/sigc++/signal_base.h
index 582a8f4..1638642 100644
--- a/sigc++/signal_base.h
+++ b/sigc++/signal_base.h
@@ -28,6 +28,8 @@
 #include <sigc++/functors/slot.h>
 #include <sigc++/functors/mem_fun.h>
 
+/** The libsigc++ namespace.
+ */
 namespace sigc
 {
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]