[gimp] app: Add some comments on classes used for the dock system

[Martin Nordholts <martinn src gnome org>]

commit 04ef83c7958fd06c8fa1043b85069cb96f67e782
Author: Martin Nordholts <martinn src gnome org>
Date:   Sat Sep 5 23:50:01 2009 +0200

    app: Add some comments on classes used for the dock system

 app/widgets/gimpdock.h          |    3 +++
 app/widgets/gimpdockable.h      |    5 +++++
 app/widgets/gimpdockbook.h      |    4 ++++
 app/widgets/gimpdocked.h        |    3 +++
 app/widgets/gimpdockseparator.h |    4 ++++
 app/widgets/gimpimagedock.h     |    3 +++
 6 files changed, 22 insertions(+), 0 deletions(-)
---
diff --git a/app/widgets/gimpdock.h b/app/widgets/gimpdock.h
index 9967b2a..3cdb3f3 100644
--- a/app/widgets/gimpdock.h
+++ b/app/widgets/gimpdock.h
@@ -36,6 +36,9 @@
 typedef struct _GimpDockClass GimpDockClass;
 typedef struct _GimpDockPriv  GimpDockPriv;
 
+/**
+ * A top-level window containing GimpDockbooks.
+ */
 struct _GimpDock
 {
   GimpWindow    parent_instance;
diff --git a/app/widgets/gimpdockable.h b/app/widgets/gimpdockable.h
index c295225..3dcad1f 100644
--- a/app/widgets/gimpdockable.h
+++ b/app/widgets/gimpdockable.h
@@ -35,6 +35,11 @@
 
 typedef struct _GimpDockableClass GimpDockableClass;
 
+/**
+ * A kind of adpater to make other widgets dockable. The widget to
+ * dock is put inside the GimpDockable, which is put in a
+ * GimpDockbook.
+ */
 struct _GimpDockable
 {
   GtkBin        parent_instance;
diff --git a/app/widgets/gimpdockbook.h b/app/widgets/gimpdockbook.h
index 5cea30a..689accb 100644
--- a/app/widgets/gimpdockbook.h
+++ b/app/widgets/gimpdockbook.h
@@ -32,6 +32,10 @@
 
 typedef struct _GimpDockbookClass  GimpDockbookClass;
 
+/**
+ * Holds GimpDockables which are presented on different tabs using
+ * GtkNotebook.
+ */
 struct _GimpDockbook
 {
   GtkNotebook    parent_instance;
diff --git a/app/widgets/gimpdocked.h b/app/widgets/gimpdocked.h
index 0690927..50dac25 100644
--- a/app/widgets/gimpdocked.h
+++ b/app/widgets/gimpdocked.h
@@ -30,6 +30,9 @@
 
 typedef struct _GimpDockedInterface GimpDockedInterface;
 
+/**
+ * Interface with common methods for stuff that is docked.
+ */
 struct _GimpDockedInterface
 {
   GTypeInterface base_iface;
diff --git a/app/widgets/gimpdockseparator.h b/app/widgets/gimpdockseparator.h
index 811bfde..85ff03b 100644
--- a/app/widgets/gimpdockseparator.h
+++ b/app/widgets/gimpdockseparator.h
@@ -32,6 +32,10 @@
 
 typedef struct _GimpDockSeparatorClass GimpDockSeparatorClass;
 
+/**
+ * Separates dockable and acts as drop-targets to allow rearrangements
+ * of them.
+ */
 struct _GimpDockSeparator
 {
   GtkEventBox    parent_instance;
diff --git a/app/widgets/gimpimagedock.h b/app/widgets/gimpimagedock.h
index cc107f4..9ca28b5 100644
--- a/app/widgets/gimpimagedock.h
+++ b/app/widgets/gimpimagedock.h
@@ -35,6 +35,9 @@
 
 typedef struct _GimpImageDockClass   GimpImageDockClass;
 
+/**
+ * Adds some GimpImage specific hooks and logic to GimpDock.
+ */
 struct _GimpImageDock
 {
   GimpDock       parent_instance;