[gimp] libgimpthumb: fix all gtk-doc warnings, and reach 100% doc coverage, yay!



commit 8efe98649e0dceaf2bb3bf66cd6f5ba818df73af
Author: Michael Natterer <mitch gimp org>
Date:   Fri Jul 2 16:01:40 2010 +0200

    libgimpthumb: fix all gtk-doc warnings, and reach 100% doc coverage, yay!

 libgimpthumb/gimpthumb-enums.h |    4 ++--
 libgimpthumb/gimpthumb-utils.c |   10 +++++-----
 libgimpthumb/gimpthumbnail.c   |    2 ++
 libgimpthumb/gimpthumbnail.h   |    6 ++++++
 4 files changed, 15 insertions(+), 7 deletions(-)
---
diff --git a/libgimpthumb/gimpthumb-enums.h b/libgimpthumb/gimpthumb-enums.h
index b86b8a6..3d72a8d 100644
--- a/libgimpthumb/gimpthumb-enums.h
+++ b/libgimpthumb/gimpthumb-enums.h
@@ -85,8 +85,8 @@ typedef enum
  * GimpThumbState:
  * @GIMP_THUMB_STATE_UNKNOWN:   nothing is known about the file/thumbnail
  * @GIMP_THUMB_STATE_REMOTE:    the file is on a remote file system
- * @GIMP_THUMB_STATE_FOLDER:
- * @GIMP_THUMB_STATE_SPECIAL:
+ * @GIMP_THUMB_STATE_FOLDER:    the file is a directory
+ * @GIMP_THUMB_STATE_SPECIAL:   the file is a special file
  * @GIMP_THUMB_STATE_NOT_FOUND: the file/thumbnail doesn't exist
  * @GIMP_THUMB_STATE_EXISTS:    the file/thumbnail exists
  * @GIMP_THUMB_STATE_OLD:       the thumbnail may be outdated
diff --git a/libgimpthumb/gimpthumb-utils.c b/libgimpthumb/gimpthumb-utils.c
index 15b946c..07252ab 100644
--- a/libgimpthumb/gimpthumb-utils.c
+++ b/libgimpthumb/gimpthumb-utils.c
@@ -186,8 +186,8 @@ gimp_thumb_get_thumb_dir (GimpThumbSize  size)
 
 /**
  * gimp_thumb_get_thumb_dir_local:
- * @dirname:
- * @size: a GimpThumbSize
+ * @dirname: the basename of the dir, without the actual dirname itself
+ * @size:    a GimpThumbSize
  *
  * Retrieve the name of the local thumbnail folder for a specific
  * size.  Unlike gimp_thumb_get_thumb_dir() the returned string is not
@@ -260,9 +260,9 @@ gimp_thumb_ensure_thumb_dir (GimpThumbSize   size,
 
 /**
  * gimp_thumb_ensure_thumb_dir_local:
- * @dirname:
- * @size: a GimpThumbSize
- * @error: return location for possible errors
+ * @dirname: the basename of the dir, without the actual dirname itself
+ * @size:    a GimpThumbSize
+ * @error:   return location for possible errors
  *
  * This function checks if the directory that is required to store
  * local thumbnails for a particular @size exist and attempts to
diff --git a/libgimpthumb/gimpthumbnail.c b/libgimpthumb/gimpthumbnail.c
index c64b3a0..ce67268 100644
--- a/libgimpthumb/gimpthumbnail.c
+++ b/libgimpthumb/gimpthumbnail.c
@@ -169,6 +169,8 @@ gimp_thumbnail_class_init (GimpThumbnailClass *klass)
   /**
    * GimpThumbnail::image-mimetype:
    *
+   * Image mimetype
+   *
    * Since: GIMP 2.2
    **/
   g_object_class_install_property (object_class,
diff --git a/libgimpthumb/gimpthumbnail.h b/libgimpthumb/gimpthumbnail.h
index e8eeb7d..cc957a1 100644
--- a/libgimpthumb/gimpthumbnail.h
+++ b/libgimpthumb/gimpthumbnail.h
@@ -38,6 +38,12 @@ G_BEGIN_DECLS
 
 typedef struct _GimpThumbnailClass GimpThumbnailClass;
 
+/**
+ * GimpThumbnail:
+ *
+ * All members of #GimpThumbnail are private and should only be accessed
+ * using object properties.
+ **/
 struct _GimpThumbnail
 {
   GObject         parent_instance;



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