Documented the function pointer templates for object_functions, as used in device.c

2010-03-02 20:44:46 +00:00
parent d4b39c6b59
commit 6c799cb847
6 changed files with 60 additions and 2 deletions
@@ -49,6 +49,15 @@ typedef struct BACnet_Read_Access_Data {
    struct BACnet_Read_Access_Data *next;
 } BACNET_READ_ACCESS_DATA;

+/** Fetches the lists of properties (array of BACNET_PROPERTY_ID's) for this
+ *  object type, grouped by Required, Optional, and Proprietary.
+ * A function template; @see device.c for assignment to object types.
+ *
+ * @param pRequired [out] Pointer reference for the list of Required properties.
+ * @param pOptional [out] Pointer reference for the list of Optional properties.
+ * @param pProprietary [out] Pointer reference for the list of Proprietary
+ *                           properties for this BACNET_OBJECT_TYPE.
+ */
 typedef void (
    *rpm_property_lists_function) (
    const int **pRequired,