[libgsf] Doc fixes.



commit fe360ae2cdaaaca42c2c7a279c455aa6d9ba488f
Author: Morten Welinder <terra gnome org>
Date:   Thu Mar 7 18:05:24 2013 -0500

    Doc fixes.

 gsf/gsf-infile-tar.c    |    2 +-
 gsf/gsf-infile.c        |    2 +-
 gsf/gsf-input-memory.c  |    2 +-
 gsf/gsf-msole-utils.c   |    2 +-
 gsf/gsf-outfile-stdio.c |    4 ++--
 gsf/gsf-output-memory.c |    2 +-
 gsf/gsf-utils.c         |    1 +
 7 files changed, 8 insertions(+), 7 deletions(-)
---
diff --git a/gsf/gsf-infile-tar.c b/gsf/gsf-infile-tar.c
index 817245e..99cdc9f 100644
--- a/gsf/gsf-infile-tar.c
+++ b/gsf/gsf-infile-tar.c
@@ -567,7 +567,7 @@ GSF_CLASS (GsfInfileTar, gsf_infile_tar,
 /**
  * gsf_infile_tar_new:
  * @source: A base #GsfInput
- * @err: A #GError, optionally %null
+ * @err: A #GError, optionally %NULL
  *
  * Opens the root directory of a Tar file.
  * <note>This adds a reference to @source.</note>
diff --git a/gsf/gsf-infile.c b/gsf/gsf-infile.c
index 1aea12b..bf01f37 100644
--- a/gsf/gsf-infile.c
+++ b/gsf/gsf-infile.c
@@ -124,7 +124,7 @@ gsf_infile_child_by_name (GsfInfile *infile, char const *name)
 
 /**
  * gsf_infile_child_by_vname:
- * @infile:
+ * @infile: a #GsfInfile
  * @...: A %NULL terminated list of names
  *
  * Apart from the way arguments are specified, this is the same as
diff --git a/gsf/gsf-input-memory.c b/gsf/gsf-input-memory.c
index 6f72f7b..30801a7 100644
--- a/gsf/gsf-input-memory.c
+++ b/gsf/gsf-input-memory.c
@@ -191,7 +191,7 @@ GSF_CLASS (GsfInputMemory, gsf_input_memory,
 /**
  * gsf_input_mmap_new:
  * @filename: The file on disk that you want to mmap
- * @err: A #GError, or optionally %null
+ * @err: A #GError, or optionally %NULL
  *
  * Returns: A new #GsfInputMemory
  */
diff --git a/gsf/gsf-msole-utils.c b/gsf/gsf-msole-utils.c
index ec72ba2..75aadcf 100644
--- a/gsf/gsf-msole-utils.c
+++ b/gsf/gsf-msole-utils.c
@@ -1970,7 +1970,7 @@ static struct {
  * @lang:
  *
  * Returns: the LID (Language Identifier) for the input language.
- *     If lang is %null, return 0x0400 ("-none-"), and not 0x0000 ("no proofing")
+ *     If lang is %NULL, return 0x0400 ("-none-"), and not 0x0000 ("no proofing")
  **/
 guint
 gsf_msole_lid_for_language (char const *lang)
diff --git a/gsf/gsf-outfile-stdio.c b/gsf/gsf-outfile-stdio.c
index 834fb98..d48e1c1 100644
--- a/gsf/gsf-outfile-stdio.c
+++ b/gsf/gsf-outfile-stdio.c
@@ -108,7 +108,7 @@ GSF_CLASS (GsfOutfileStdio, gsf_outfile_stdio,
  * @first_property_name: name of first property to set
  * @var_args: a %NULL-terminated #va_list
  *
- * Returns (transfer full): a new outfile or %NULL.
+ * Returns: (transfer full): a new outfile or %NULL.
  **/
 GsfOutfile *
 gsf_outfile_stdio_new_valist (char const *root, GError **err,
@@ -145,7 +145,7 @@ gsf_outfile_stdio_new_valist (char const *root, GError **err,
  * @...: value of first property, followed by more properties,
  *             %NULL-terminated
  *
- * Returns (transfer full): a new outfile or %NULL.
+ * Returns: (transfer full): a new outfile or %NULL.
  **/
 GsfOutfile *
 gsf_outfile_stdio_new_full (char const *root, GError **err,
diff --git a/gsf/gsf-output-memory.c b/gsf/gsf-output-memory.c
index e6a0de3..2f6e5c7 100644
--- a/gsf/gsf-output-memory.c
+++ b/gsf/gsf-output-memory.c
@@ -188,7 +188,7 @@ gsf_output_memory_class_init (GObjectClass *gobject_class)
  * gsf_output_memory_get_bytes:
  * @mem: the output device.
  *
- * Returns: The data that has been written to @mem, or %null
+ * Returns: The data that has been written to @mem, or %NULL
  **/
 const guint8 *
 gsf_output_memory_get_bytes (GsfOutputMemory * mem)
diff --git a/gsf/gsf-utils.c b/gsf/gsf-utils.c
index 3cc0b8d..92d8dc5 100644
--- a/gsf/gsf-utils.c
+++ b/gsf/gsf-utils.c
@@ -230,6 +230,7 @@ gsf_init_dynamic (GTypeModule *module)
 
 /**
  * gsf_shutdown_dynamic:
+ * @module: currently unused
  *
  * De-intializes the GSF library from a type module.
  * Currently does nothing.


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