SF.net SVN: geany:[5718] trunk

[ntrel at users.sourceforge.net]

Revision: 5718
          http://geany.svn.sourceforge.net/geany/?rev=5718&view=rev
Author:   ntrel
Date:     2011-04-13 12:16:02 +0000 (Wed, 13 Apr 2011)

Log Message:
-----------
Update dox for document_compare_by_display_name() with warning
about parameter addresses.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/src/document.c

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2011-04-12 21:58:18 UTC (rev 5717)
+++ trunk/ChangeLog	2011-04-13 12:16:02 UTC (rev 5718)
@@ -1,3 +1,10 @@
+2011-04-13  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
+
+ * src/document.c:
+   Update dox for document_compare_by_display_name() with warning
+   about parameter addresses.
+
+
 2011-04-12  Enrico Tröger  <enrico(dot)troeger(at)uvena(dot)de>
 
  * src/document.c:

Modified: trunk/src/document.c
===================================================================
--- trunk/src/document.c	2011-04-12 21:58:18 UTC (rev 5717)
+++ trunk/src/document.c	2011-04-13 12:16:02 UTC (rev 5718)
@@ -3013,15 +3013,16 @@
 }
 
 
-/** GCompareFunc-like sort function to sort documents, e.g. in a GPtrArray by
- *  their display names.
- *  Display names means the base name of the document's file.
+/** Compares documents by their display names.
+ * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
+ * @note 'Display name' means the base name of the document's filename.
  *
- * @param a @c document a.
- * @param b @c document b.
- * @return negative value if a < b; zero if a = b; positive value if a > b.
+ * @param a @c GeanyDocument**.
+ * @param b @c GeanyDocument**.
+ * @warning The arguments take the address of each document pointer.
+ * @return Negative value if a < b; zero if a = b; positive value if a > b.
  *
- *  @since 0.21
+ * @since 0.21
  */
 gint document_compare_by_display_name(gconstpointer a, gconstpointer b)
 {


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.