HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update dox for document_compare_by_display_name() with warning

Browse Source 
about parameter addresses.



git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@5718 ea778897-0a13-0410-b9d1-a72fbfd435f5
This commit is contained in:
Nick Treleaven 2011-04-13 12:16:02 +00:00
parent 85b89bb53d
commit 5e4c8e0ade
2 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ChangeLog
View File

@ -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> 2011-04-12 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
* src/document.c: * src/document.c:

15
src/document.c
View File

@ -3013,15 +3013,16 @@ gboolean document_check_disk_status(GeanyDocument *doc, gboolean force)
} }
/** GCompareFunc-like sort function to sort documents, e.g. in a GPtrArray by /** Compares documents by their display names.
* their display names. * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
* Display names means the base name of the document's file. * @note 'Display name' means the base name of the document's filename.
* *
* @param a @c document a. * @param a @c GeanyDocument**.
* @param b @c document b. * @param b @c GeanyDocument**.
* @return negative value if a < b; zero if a = b; positive value if a > b. * @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) gint document_compare_by_display_name(gconstpointer a, gconstpointer b)
{ {