[goocanvasmm] Documentation improvements.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [goocanvasmm] Documentation improvements.
- Date: Tue, 4 May 2010 20:35:43 +0000 (UTC)
commit a1cc55a1aa4532987da0643aa31d9c1d64154ca7
Author: Murray Cumming <murrayc murrayc com>
Date: Tue May 4 22:35:32 2010 +0200
Documentation improvements.
* goocanvas/goocanvasmm.h: Slight improvements to main page text, adding a
link to the Canvas widget class.
* goocanvas/src/canvas.hg: Added a class description.
* doc/reference/Doxyfile.in: Make more like gtkmm's. In particular, show
undocumented classes (they should be documented though).
ChangeLog | 10 ++++++++++
doc/reference/Doxyfile.in | 10 +++++-----
goocanvas/goocanvasmm.h | 5 ++---
goocanvas/src/canvas.hg | 3 +++
4 files changed, 20 insertions(+), 8 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 5690736..2799bef 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2010-05-04 Murray Cumming <murrayc murrayc com>
+
+ Documentation improvements.
+
+ * goocanvas/goocanvasmm.h: Slight improvements to main page text, adding a
+ link to the Canvas widget class.
+ * goocanvas/src/canvas.hg: Added a class description.
+ * doc/reference/Doxyfile.in: Make more like gtkmm's. In particular, show
+ undocumented classes (they should be documented though).
+
2010-04-23 David King <davidk openismus com>
Add main page to Doxygen documentation
diff --git a/doc/reference/Doxyfile.in b/doc/reference/Doxyfile.in
index 0f29ca6..5f21031 100644
--- a/doc/reference/Doxyfile.in
+++ b/doc/reference/Doxyfile.in
@@ -54,8 +54,8 @@ EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
-HIDE_UNDOC_MEMBERS = YES
-HIDE_UNDOC_CLASSES = YES
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = YES
HIDE_IN_BODY_DOCS = YES
INTERNAL_DOCS = NO
@@ -131,7 +131,7 @@ VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX = NO
+ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
@@ -255,7 +255,7 @@ PERL_PATH = @PERL@
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = NO
+CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = YES
@@ -263,7 +263,7 @@ DOT_FONTNAME = FreeSans
DOT_FONTSIZE = 10
DOT_FONTPATH =
CLASS_GRAPH = YES
-COLLABORATION_GRAPH = YES
+COLLABORATION_GRAPH = NO
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = YES
diff --git a/goocanvas/goocanvasmm.h b/goocanvas/goocanvasmm.h
index 88b3f41..553a5a6 100644
--- a/goocanvas/goocanvasmm.h
+++ b/goocanvas/goocanvasmm.h
@@ -24,9 +24,8 @@
*
* @section description Description
*
- * goocanvasmm is a C++ binding for goocanvas. See also
- * <a href="http://live.gnome.org/GooCanvas">the goocanvas website</a> for a
- * description of goocanvas.
+ * goocanvasmm is a C++ binding for <a href="http://live.gnome.org/GooCanvas">goocanvas</a>.
+ * See the Goocanvas::Canvas widget.
*
* @section basics Basic Usage
* Include the goocanvasmm header:
diff --git a/goocanvas/src/canvas.hg b/goocanvas/src/canvas.hg
index 65a6650..5067b10 100644
--- a/goocanvas/src/canvas.hg
+++ b/goocanvas/src/canvas.hg
@@ -35,6 +35,9 @@ _PINCLUDE(gtkmm/private/container_p.h)
namespace Goocanvas
{
+/** The main canvas widget, containing a number of canvas items.
+ * Add child items (see Item) to the root item (see get_root_item()), for instance with Item::add_child().
+ */
class Canvas :
public Gtk::Container
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]