r20625 - gnucash/trunk/src/engine - Fix doxygen comments

Geert Janssens gjanssens at code.gnucash.org
Wed May 11 17:51:55 EDT 2011


Author: gjanssens
Date: 2011-05-11 17:51:54 -0400 (Wed, 11 May 2011)
New Revision: 20625
Trac: http://svn.gnucash.org/trac/changeset/20625

Modified:
   gnucash/trunk/src/engine/gncOwner.h
Log:
Fix doxygen comments

Modified: gnucash/trunk/src/engine/gncOwner.h
===================================================================
--- gnucash/trunk/src/engine/gncOwner.h	2011-05-11 21:51:45 UTC (rev 20624)
+++ gnucash/trunk/src/engine/gncOwner.h	2011-05-11 21:51:54 UTC (rev 20625)
@@ -134,12 +134,16 @@
 /** \name Comparison routines.
  @{
  */
-gboolean gncOwnerEqual (const GncOwner *a, const GncOwner *b); /** Check if both objects refer to the same owner type
-                                                                   if and the owner reference points to the same
-                                                                   {vendor/customer/employee} in memory */
-int gncOwnerGCompareFunc (const GncOwner *a, const GncOwner *b); /** Same as gncOwnerEqual, but returns 0 if
-                                                                     equal to be used as a GList custom compare function */
-int gncOwnerCompare (const GncOwner *a, const GncOwner *b); /** Sort on name */
+/** Assess equality by checking
+ *  - if both owner objects refer to the same owner type
+ *  - and if the owner reference points to the same
+ *    {vendor/customer/employee} in memory */
+gboolean gncOwnerEqual (const GncOwner *a, const GncOwner *b);
+/** Same as gncOwnerEqual, but returns 0 if
+    equal to be used as a GList custom compare function */
+int gncOwnerGCompareFunc (const GncOwner *a, const GncOwner *b);
+/** Sort on name */
+int gncOwnerCompare (const GncOwner *a, const GncOwner *b);
 /** @} */
 
 /** Get the GncGUID of the immediate owner */



More information about the gnucash-changes mailing list