Documentation trivia

diff --git a/ChangeLog b/ChangeLog
index 147d53d9e85711dd5bc482f787a5b2abd36bd01e..19a94687bcf40b73d61b4bfc95937184f1187958 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2005-05-02  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gstring.c (g_str_equal, g_str_hash): Move docs
+       inline.
+
 2005-05-01  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/ghash.h: Rename some parameters to make gtk-doc

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 147d53d9e85711dd5bc482f787a5b2abd36bd01e..19a94687bcf40b73d61b4bfc95937184f1187958 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,8 @@
+2005-05-02  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gstring.c (g_str_equal, g_str_hash): Move docs
+       inline.
+
 2005-05-01  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/ghash.h: Rename some parameters to make gtk-doc

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 147d53d9e85711dd5bc482f787a5b2abd36bd01e..19a94687bcf40b73d61b4bfc95937184f1187958 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,8 @@
+2005-05-02  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gstring.c (g_str_equal, g_str_hash): Move docs
+       inline.
+
 2005-05-01  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/ghash.h: Rename some parameters to make gtk-doc

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 147d53d9e85711dd5bc482f787a5b2abd36bd01e..19a94687bcf40b73d61b4bfc95937184f1187958 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,8 @@
+2005-05-02  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gstring.c (g_str_equal, g_str_hash): Move docs
+       inline.
+
 2005-05-01  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/ghash.h: Rename some parameters to make gtk-doc

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index c99575b3b1983b6c5700ab8fc0ca0375aca87084..bda5fd3d1e40b3eb2e4bb716616919ed2cd10879 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,8 @@
 2005-05-02  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/tmpl/hash_tables.sgml: Move some docs inline.
+
+       * glib/tmpl/windows.sgml: 
        * gobject/tmpl/signals.sgml: 
        * gobject/tmpl/generic_values.sgml: 
        * gobject/tmpl/gtype.sgml: 

diff --git a/docs/reference/glib/tmpl/hash_tables.sgml b/docs/reference/glib/tmpl/hash_tables.sgml
index 006b8302461c704d21eb274abd17a790e9286fbd..339e80770c64acd5f164e8d7b72c04de2d48e7e4 100644 (file)
--- a/docs/reference/glib/tmpl/hash_tables.sgml
+++ b/docs/reference/glib/tmpl/hash_tables.sgml
@@ -51,6 +51,9 @@ To destroy a #GHashTable use g_hash_table_destroy().
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### STRUCT GHashTable ##### -->
 <para>
 The <structname>GHashTable</structname> struct is an opaque data structure to represent a
@@ -311,8 +314,6 @@ This function is deprecated and will be removed in the next major
 @v1: 
 @v2: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@v: 
 
 
 <!-- ##### FUNCTION g_int_hash ##### -->
@@ -326,26 +327,18 @@ This function is deprecated and will be removed in the next major
 
 <!-- ##### FUNCTION g_str_equal ##### -->
 <para>
-Compares two strings and returns %TRUE if they are equal.
-It can be passed to g_hash_table_new() as the @key_equal_func
-parameter, when using strings as keys in a #GHashTable.
 </para>
 
 @v1: 
-@v2: a key to compare with @v.
-@Returns: %TRUE if the two keys match.
-<!-- # Unused Parameters # -->
-@v: a key.
+@v2: 
+@Returns:
 
 
 <!-- ##### FUNCTION g_str_hash ##### -->
 <para>
-Converts a string to a hash value.
-It can be passed to g_hash_table_new() as the @hash_func parameter, when
-using strings as keys in a #GHashTable.
 </para>
 
-@v: a string key.
-@Returns: a hash value corresponding to the key.
+@v:
+@Returns:
 
 

diff --git a/docs/reference/glib/tmpl/windows.sgml b/docs/reference/glib/tmpl/windows.sgml
index 9f799fdc0833820ea4c8137d43e7b3c912c2e458..f2e59e831297225a382625a39c98192c5f1c12f3 100644 (file)
--- a/docs/reference/glib/tmpl/windows.sgml
+++ b/docs/reference/glib/tmpl/windows.sgml
@@ -14,6 +14,9 @@ UNIX emulation on Windows.
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### MACRO MAXPATHLEN ##### -->
 <para>
 Provided for UNIX emulation on Windows; equivalent to UNIX 
@@ -23,19 +26,13 @@ macro %MAXPATHLEN, which is the maximum length of a filename
 
 
 
-<!-- ##### TYPEDEF pid_t ##### -->
-<para>
-Provided for UNIX emulation on Windows; process ID type.
-</para>
-
-
 <!-- ##### MACRO pipe ##### -->
 <para>
 Provided for UNIX emulation on Windows; see documentation for <function>pipe()</function>
 in any UNIX manual.
 </para>
 
-@phandles: 
+@phandles: file descriptors, the first one for reading, the second one for writing.
 
 
 <!-- ##### FUNCTION g_win32_error_message ##### -->
@@ -84,6 +81,15 @@ in any UNIX manual.
 @Returns: 
 
 
+<!-- ##### FUNCTION g_win32_locale_filename_from_utf8 ##### -->
+<para>
+
+</para>
+
+@utf8filename: 
+@Returns: 
+
+
 <!-- ##### MACRO G_WIN32_DLLMAIN_FOR_DLL_NAME ##### -->
 <para>
 On Windows, this macro defines a <function>DllMain()</function> function 

diff --git a/glib/gstring.c b/glib/gstring.c
index 892930ad1252d2cc6e52a80fb98720330eb06283..7eec7f91c6a71fc6f640ce7b690cdca15e36e715 100644 (file)
--- a/glib/gstring.c
+++ b/glib/gstring.c
@@ -59,6 +59,17 @@ static GMemChunk *string_mem_chunk = NULL;
 /* Hash Functions.
  */
 
+/**
+ * g_str_equal:
+ * @v1: a key. 
+ * @v2: a key to compare with @v1.
+ * 
+ * Compares two strings and returns %TRUE if they are equal.
+ * It can be passed to g_hash_table_new() as the @key_equal_func
+ * parameter, when using strings as keys in a #GHashTable.
+ *
+ * Returns: %TRUE if the two keys match.
+ */
 gboolean
 g_str_equal (gconstpointer v1,
             gconstpointer v2)
@@ -69,11 +80,21 @@ g_str_equal (gconstpointer v1,
   return strcmp (string1, string2) == 0;
 }
 
-/* 31 bit hash function */
+/**
+ * g_str_hash:
+ * @v: a string key.
+ *
+ * Converts a string to a hash value.
+ * It can be passed to g_hash_table_new() as the @hash_func parameter, 
+ * when using strings as keys in a #GHashTable.
+ *
+ * Returns: a hash value corresponding to the key.
+ */
 guint
-g_str_hash (gconstpointer key)
+g_str_hash (gconstpointer v)
 {
-  const char *p = key;
+  /* 31 bit hash function */
+  const char *p = v;
   guint h = *p;
 
   if (h)