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
@@ -124,8 +124,11 @@ typedef struct rrpropertyinfo {
    rr_handler_function Handler;
    } RR_PROP_INFO;

-/** Function pointer for ReadRange information retrieval function */
-
+/** Function template for ReadRange information retrieval function.
+ * @param pRequest [in]	Info on the request.
+ * @param pInfo [out]   Where to write the response to.
+ * @return True on success, False on error or failure.
+ */
 typedef bool (*rr_info_function) (
    BACNET_READ_RANGE_DATA *pRequest, /* Info on the request */
    RR_PROP_INFO *pInfo);         /* Where to write the response to */