r21388 - gnucash/trunk/src/engine - Documentation improvement of GncOwner functions.

Christian Stimming cstim at code.gnucash.org
Sat Oct 8 05:19:54 EDT 2011


Author: cstim
Date: 2011-10-08 05:19:54 -0400 (Sat, 08 Oct 2011)
New Revision: 21388
Trac: http://svn.gnucash.org/trac/changeset/21388

Modified:
   gnucash/trunk/src/engine/gncOwner.h
Log:
Documentation improvement of GncOwner functions.

Modified: gnucash/trunk/src/engine/gncOwner.h
===================================================================
--- gnucash/trunk/src/engine/gncOwner.h	2011-10-08 08:46:28 UTC (rev 21387)
+++ gnucash/trunk/src/engine/gncOwner.h	2011-10-08 09:19:54 UTC (rev 21388)
@@ -114,11 +114,26 @@
 /** \name Get routines.
 @{
 */
+/** Returns the GncOwnerType of this owner. (Not to be confused with qofOwnerGetType().) */
 GncOwnerType gncOwnerGetType (const GncOwner *owner);
+/** Returns TRUE if the given owner is one of the valid objects.
+ * Returns FALSE if the owner is (still) undefined, or if it is NULL. */
+gboolean gncOwnerIsValid (const GncOwner *owner);
+
+/** If the given owner is of type GNC_OWNER_UNDEFINED, returns the undefined
+ * pointer, which is usually NULL. Otherwise returns NULL. */
 gpointer gncOwnerGetUndefined (const GncOwner *owner);
+/** If the given owner is of type GNC_OWNER_CUSTOMER, returns the pointer
+ * to the customer object. Otherwise returns NULL. */
 GncCustomer * gncOwnerGetCustomer (const GncOwner *owner);
+/** If the given owner is of type GNC_OWNER_JOB, returns the pointer
+ * to the job object. Otherwise returns NULL. */
 GncJob * gncOwnerGetJob (const GncOwner *owner);
+/** If the given owner is of type GNC_OWNER_VENDOR, returns the pointer
+ * to the vendor object. Otherwise returns NULL. */
 GncVendor * gncOwnerGetVendor (const GncOwner *owner);
+/** If the given owner is of type GNC_OWNER_EMPLOYEE, returns the pointer
+ * to the employee object. Otherwise returns NULL. */
 GncEmployee * gncOwnerGetEmployee (const GncOwner *owner);
 
 const char * gncOwnerGetID (const GncOwner *owner);
@@ -156,8 +171,6 @@
 const GncGUID * gncOwnerGetGUID (const GncOwner *owner);
 GncGUID gncOwnerRetGUID (GncOwner *owner);
 
-gboolean gncOwnerIsValid (const GncOwner *owner);
-
 /**
  * Get the "parent" Owner or GncGUID thereof.  The "parent" owner
  * is the Customer or Vendor, or the Owner of a Job



More information about the gnucash-changes mailing list