libgimpconfig: fix a lot of gtk-doc warnings

Author: mitchfoo

devel-docs/libgimpconfig/libgimpconfig-sections.txt

@@ -3,9 +3,11 @@
 <TITLE>GimpConfig</TITLE>
 GimpConfig
 GimpConfigInterface
+gimp_config_serialize
 gimp_config_serialize_to_file
 gimp_config_serialize_to_fd
 gimp_config_serialize_to_string
+gimp_config_deserialize
 gimp_config_deserialize_file
 gimp_config_deserialize_string
 gimp_config_deserialize_return
@@ -63,6 +65,7 @@ GIMP_CONFIG_INSTALL_PROP_POINTER
 
 <SECTION>
 <FILE>gimpconfig-path</FILE>
+GimpConfigPath
 GimpConfigPathType
 gimp_param_spec_config_path
 gimp_param_spec_config_path_type

devel-docs/libgimpconfig/libgimpconfig.types

@@ -1,4 +1,5 @@
 #include <glib-object.h>
 #include <libgimpconfig/gimpconfig.h>
 
+gimp_config_interface_get_type
 gimp_color_config_get_type

libgimpconfig/gimpconfig-deserialize.c

@@ -112,7 +112,7 @@ scanner_string_utf8_valid (GScanner    *scanner,
  * gimp_config_deserialize_properties:
  * @config: a #GimpConfig.
  * @scanner: a #GScanner.
- * @nest_level:
+ * @nest_level: the nest level
  *
  * This function uses the @scanner to configure the properties of @config.
  *
@@ -213,7 +213,7 @@ gimp_config_deserialize_properties (GimpConfig *config,
  * gimp_config_deserialize_property:
  * @config: a #GimpConfig.
  * @scanner: a #GScanner.
- * @nest_level:
+ * @nest_level: the nest level
  *
  * This function deserializes a single property of @config. You
  * shouldn't need to call this function directly. If possible, use

libgimpconfig/gimpconfig-error.h

@@ -26,13 +26,23 @@ G_BEGIN_DECLS
 /* For information look into the C source or the html documentation */
 
 
+/**
+ * GimpConfigError:
+ * @GIMP_CONFIG_ERROR_OPEN:        open failed
+ * @GIMP_CONFIG_ERROR_OPEN_ENOENT: file does not exist
+ * @GIMP_CONFIG_ERROR_WRITE:       write failed
+ * @GIMP_CONFIG_ERROR_PARSE:       parser error
+ * @GIMP_CONFIG_ERROR_VERSION:     parser failed due to version mismatch
+ *
+ * The possible values of a #GError thrown by libgimpconfig.
+ **/
 typedef enum
 {
-  GIMP_CONFIG_ERROR_OPEN,         /*  open failed                            */
-  GIMP_CONFIG_ERROR_OPEN_ENOENT,  /*  file does not exist                    */
-  GIMP_CONFIG_ERROR_WRITE,        /*  write failed                           */
-  GIMP_CONFIG_ERROR_PARSE,        /*  parser error                           */
-  GIMP_CONFIG_ERROR_VERSION       /*  parser failed due to version mismatch  */
+  GIMP_CONFIG_ERROR_OPEN,
+  GIMP_CONFIG_ERROR_OPEN_ENOENT,
+  GIMP_CONFIG_ERROR_WRITE,
+  GIMP_CONFIG_ERROR_PARSE,
+  GIMP_CONFIG_ERROR_VERSION
 } GimpConfigError;
 
 #define GIMP_CONFIG_ERROR (gimp_config_error_quark ())

libgimpconfig/gimpconfig-iface.c

@@ -263,7 +263,7 @@ gimp_config_iface_copy (GimpConfig  *src,
  * @header: optional file header (must be ASCII only)
  * @footer: optional file footer (must be ASCII only)
  * @data: user data passed to the serialize implementation.
- * @error:
+ * @error: return location for a possible error
  *
  * Serializes the object properties of @config to the file specified
  * by @filename. If a file with that name already exists, it is
@@ -336,7 +336,7 @@ gimp_config_serialize_to_fd (GimpConfig *config,
  *
  * Serializes the object properties of @config to a string.
  *
- * Return value: a newly allocated %NUL-terminated string.
+ * Return value: a newly allocated NUL-terminated string.
  *
  * Since: GIMP 2.4
  **/
@@ -364,7 +364,7 @@ gimp_config_serialize_to_string (GimpConfig *config,
  * @config: a #GObject that implements the #GimpConfigInterface.
  * @filename: the name of the file to read configuration from.
  * @data: user data passed to the deserialize implementation.
- * @error:
+ * @error: return location for a possible error
  *
  * Opens the file specified by @filename, reads configuration data
  * from it and configures @config accordingly. Basically this function
@@ -409,11 +409,11 @@ gimp_config_deserialize_file (GimpConfig   *config,
 
 /**
  * gimp_config_deserialize_string:
- * @config: a #GObject that implements the #GimpConfigInterface.
- * @text: string to deserialize (in UTF-8 encoding)
+ * @config:   a #GObject that implements the #GimpConfigInterface.
+ * @text:     string to deserialize (in UTF-8 encoding)
  * @text_len: length of @text in bytes or -1
- * @data:
- * @error:
+ * @data:     client data
+ * @error:    return location for a possible error
  *
  * Configures @config from @text. Basically this function creates a
  * properly configured #GScanner for you and calls the deserialize
@@ -456,9 +456,9 @@ gimp_config_deserialize_string (GimpConfig      *config,
 
 /**
  * gimp_config_deserialize_return:
- * @scanner:
- * @expected_token:
- * @nest_level:
+ * @scanner:        a #GScanner
+ * @expected_token: the expected token
+ * @nest_level:     the next level
  *
  * Returns:
  *

libgimpconfig/gimpconfig-path.c

@@ -131,7 +131,7 @@ gimp_param_config_path_class_init (GParamSpecClass *class)
  * @name:          Canonical name of the param
  * @nick:          Nickname of the param
  * @blurb:         Brief desciption of param.
- * @type:          a #GimpParamConfigPathType value.
+ * @type:          a #GimpConfigPathType value.
  * @default_value: Value to use if none is assigned.
  * @flags:         a combination of #GParamFlags
  *
@@ -269,7 +269,7 @@ gimp_config_build_writable_path (const gchar *name)
 
 /**
  * gimp_config_path_expand:
- * @path: a %NUL-terminated string in UTF-8 encoding
+ * @path: a NUL-terminated string in UTF-8 encoding
  * @recode: whether to convert to the filesystem's encoding
  * @error: return location for errors
  *
@@ -281,7 +281,7 @@ gimp_config_build_writable_path (const gchar *name)
  * substitution for you and can also attempt to convert to the
  * filesystem encoding.
  *
- * Return value: a newly allocated %NUL-terminated string
+ * Return value: a newly allocated NUL-terminated string
  *
  * Since: GIMP 2.4
  **/

libgimpconfig/gimpconfig-serialize.c

@@ -347,7 +347,7 @@ gimp_config_serialize_property_by_name (GimpConfig       *config,
 /**
  * gimp_config_serialize_value:
  * @value: a #GValue.
- * @str: a #Gstring.
+ * @str: a #GString.
  * @escaped: whether to escape string values.
  *
  * This utility function appends a string representation of #GValue to @str.

libgimpconfig/gimpconfigtypes.h

@@ -28,6 +28,7 @@
 
 typedef struct _GimpConfig        GimpConfig; /* dummy typedef */
 typedef struct _GimpConfigWriter  GimpConfigWriter;
+typedef gchar *                   GimpConfigPath; /* to satisfy docs */
 
 
 #include <libgimpconfig/gimpcolorconfig-enums.h>