[gimp] app: Add docs to GimpSessionInfo related classes



commit 6460385553acb4e2d0d1269cdf62581628fa219e
Author: Martin Nordholts <martinn src gnome org>
Date:   Thu Sep 17 08:09:47 2009 +0200

    app: Add docs to GimpSessionInfo related classes

 app/widgets/gimpsessioninfo-aux.h      |    4 ++++
 app/widgets/gimpsessioninfo-book.h     |    4 ++++
 app/widgets/gimpsessioninfo-dockable.h |    3 +++
 app/widgets/gimpsessioninfo.h          |    4 ++++
 4 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/app/widgets/gimpsessioninfo-aux.h b/app/widgets/gimpsessioninfo-aux.h
index 5c709cb..054bbe8 100644
--- a/app/widgets/gimpsessioninfo-aux.h
+++ b/app/widgets/gimpsessioninfo-aux.h
@@ -22,6 +22,10 @@
 #define __GIMP_SESSION_INFO_AUX_H__
 
 
+/**
+ * Contains arbitrary data in the session management system, used for
+ * example by dockables to manage dockable-specific data.
+ */
 struct _GimpSessionInfoAux
 {
   gchar *name;
diff --git a/app/widgets/gimpsessioninfo-book.h b/app/widgets/gimpsessioninfo-book.h
index d5434c0..1279de3 100644
--- a/app/widgets/gimpsessioninfo-book.h
+++ b/app/widgets/gimpsessioninfo-book.h
@@ -22,6 +22,10 @@
 #define __GIMP_SESSION_INFO_BOOK_H__
 
 
+/**
+ * Contains information about a book (a GtkNotebook of dockables) in
+ * the interface.
+ */
 struct _GimpSessionInfoBook
 {
   gint   position;
diff --git a/app/widgets/gimpsessioninfo-dockable.h b/app/widgets/gimpsessioninfo-dockable.h
index b62be18..8fedb54 100644
--- a/app/widgets/gimpsessioninfo-dockable.h
+++ b/app/widgets/gimpsessioninfo-dockable.h
@@ -22,6 +22,9 @@
 #define __GIMP_SESSION_INFO_DOCKABLE_H__
 
 
+/**
+ * Contains information about a dockable in the interface.
+ */
 struct _GimpSessionInfoDockable
 {
   gchar        *identifier;
diff --git a/app/widgets/gimpsessioninfo.h b/app/widgets/gimpsessioninfo.h
index 2f07cea..2fdc7d8 100644
--- a/app/widgets/gimpsessioninfo.h
+++ b/app/widgets/gimpsessioninfo.h
@@ -35,6 +35,10 @@
 
 typedef struct _GimpSessionInfoClass  GimpSessionInfoClass;
 
+/**
+ * Contains session info for one toplevel window in the interface such
+ * as a dock, the empty-image-window, or the open/save dialog.
+ */
 struct _GimpSessionInfo
 {
   GimpObject              parent_instance;



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