[libgsf] docs: minor fixes.



commit edaf3e9811f11baf8e031eefe9f0b0bc533ba5db
Author: Morten Welinder <terra gnome org>
Date:   Tue Mar 20 09:10:14 2012 -0400

    docs: minor fixes.

 doc/gsf-sections.txt   |   13 ++++++++-----
 gsf/gsf-infile-zip.c   |    6 ++++++
 gsf/gsf-input-stdio.c  |    2 +-
 gsf/gsf-input.c        |    7 ++++++-
 gsf/gsf-libxml.h       |    1 +
 gsf/gsf-output-stdio.c |    2 +-
 6 files changed, 23 insertions(+), 8 deletions(-)
---
diff --git a/doc/gsf-sections.txt b/doc/gsf-sections.txt
index c7699ad..046b314 100644
--- a/doc/gsf-sections.txt
+++ b/doc/gsf-sections.txt
@@ -16,9 +16,11 @@ gsf_input_error
 gsf_input_name
 gsf_input_set_name_from_filename
 
+<SUBSECTION Proxy>
 GsfInputProxy
 gsf_input_proxy_new
 gsf_input_proxy_new_section
+
 <SUBSECTION Convenience>
 gsf_input_copy
 gsf_input_uncompress
@@ -698,19 +700,18 @@ gsf_error_quark
 gsf_mem_dump
 gsf_input_dump
 gsf_debug_flag
-<SUBSECTION Types>
-GSF_OFF_T_FORMAT
-gsf_off_t
-
 gsf_filename_to_utf8
 gsf_iconv_close
 gsf_extension_pointer
-<SUBSECTION Types>
+
+<SUBSECTION Base 64 Encoding>
 gsf_base64_encode_simple
 gsf_base64_encode_close
 gsf_base64_encode_step 
 gsf_base64_decode_simple
 gsf_base64_decode_step
+
+<SUBSECTION Types>
 GSF_LE_GET_GINT8
 GSF_LE_GET_GUINT64
 GSF_LE_GET_GINT16
@@ -736,6 +737,8 @@ GSF_LE_SET_FLOAT
 GSF_LE_SET_DOUBLE
 gsf_le_set_float
 gsf_le_set_double
+GSF_OFF_T_FORMAT
+gsf_off_t
 
 <SUBSECTION TimeStamps>
 GsfTimestamp
diff --git a/gsf/gsf-infile-zip.c b/gsf/gsf-infile-zip.c
index 9bc9744..20cc86b 100644
--- a/gsf/gsf-infile-zip.c
+++ b/gsf/gsf-infile-zip.c
@@ -824,6 +824,12 @@ gsf_infile_zip_class_init (GObjectClass *gobject_class)
 				      GSF_PARAM_STATIC |
 				      G_PARAM_READWRITE |
 				      G_PARAM_CONSTRUCT_ONLY));
+
+	/**
+	 * GsfInfileZip:compression-level:
+	 *
+	 * Controls the level of compression used for new members.
+	 */
 	g_object_class_install_property
 		(gobject_class,
 		 PROP_COMPRESSION_LEVEL,
diff --git a/gsf/gsf-input-stdio.c b/gsf/gsf-input-stdio.c
index 3299bdb..b36e98d 100644
--- a/gsf/gsf-input-stdio.c
+++ b/gsf/gsf-input-stdio.c
@@ -164,7 +164,7 @@ gsf_input_stdio_new (char const *filename, GError **err)
 /**
  * gsf_input_stdio_new_FILE :
  * @filename  : The filename corresponding to @file.
- * @file      : an existing stdio FILE *
+ * @file      : an existing stdio <type>FILE</type> *
  * @keep_open : Should @file be closed when the wrapper is closed
  *
  * Assumes ownership of @file when succeeding.  If @keep_open is true,
diff --git a/gsf/gsf-input.c b/gsf/gsf-input.c
index eb0c151..1e6cb6c 100644
--- a/gsf/gsf-input.c
+++ b/gsf/gsf-input.c
@@ -132,9 +132,14 @@ gsf_input_class_init (GObjectClass *gobject_class)
 							     0, G_MAXINT64, 0,
 							     GSF_PARAM_STATIC |
 							     G_PARAM_READABLE));
+	/**
+	 * GsfInput:eof:
+	 *
+	 * True if the end of the file has been reached.
+	 */
 	g_object_class_install_property (gobject_class,
 					 PROP_EOF,
-					 g_param_spec_boolean ("eof", "OEF",
+					 g_param_spec_boolean ("eof", "EOF",
 							       "End Of File",
 							       FALSE,
 							       GSF_PARAM_STATIC |
diff --git a/gsf/gsf-libxml.h b/gsf/gsf-libxml.h
index 33da633..081f077 100644
--- a/gsf/gsf-libxml.h
+++ b/gsf/gsf-libxml.h
@@ -83,6 +83,7 @@ struct _GsfXMLIn {
 	GString		   *content;
 	GsfXMLInDoc  const *doc;
 	GsfXMLInNode const *node;	/* current node (not on the stack) */
+	/*< private >*/
 	GSList	 	   *node_stack;	/* stack of GsfXMLInNode */
 };
 
diff --git a/gsf/gsf-output-stdio.c b/gsf/gsf-output-stdio.c
index 88733da..9bf32dc 100644
--- a/gsf/gsf-output-stdio.c
+++ b/gsf/gsf-output-stdio.c
@@ -567,7 +567,7 @@ gsf_output_stdio_new (char const *filename, GError **err)
 /**
  * gsf_output_stdio_new_FILE :
  * @filename  : The filename corresponding to @file.
- * @file      : an existing stdio FILE *
+ * @file      : an existing stdio <type>FILE</type> *
  * @keep_open : Should @file be closed when the wrapper is closed
  *
  * Assumes ownership of @file.  If @keep_open is true, ownership reverts



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