Commit 3fa1688c authored by George Nash's avatar George Nash Committed by Kishen Maloor

Add doxygen documentation to the oc_obt.h header file

This adds documentation for the oc_obt.h file itself
Add documentation for the following functions:
 - oc_obt_init
 - oc_obt_shutdown
 - oc_obt_discover_unowned_devices
 - oc_obt_discover_unowned_devices_realm_local_ipv6
 - oc_obt_discover_unowned_devices_site_local_ipv6
 - oc_obt_discover_owned_devices
 - oc_obt_discover_owned_devices_realm_local_ipv6
 - oc_obt_discover_owned_devices_site_local_ipv6
 - oc_obt_discover_all_resources

Moved the DISCOVERY_CB_PERIOD macro from oc_obt_internal.h to
oc_obt.h so that value could be used to document how long the
context pointer must be valid for the discover callback.

Fixed small typo in oc_api.h
Signed-off-by: George Nash's avatarGeorge Nash <george.nash@intel.com>
parent fab7fb88
Pipeline #881 passed with stage
in 6 minutes and 52 seconds
......@@ -342,7 +342,7 @@ typedef void (*oc_factory_presets_cb_t)(size_t device, void *data);
*
* @param[in] cb oc_factory_presets_cb_t function pointer to be called
* @param[in] data context pointer that is passed to the oc_factory_presets_cb_t
* the pointer must be a valid point till after oc_main_init()
* the pointer must be a valid pointer till after oc_main_init()
* call completes.
*/
void oc_set_factory_presets_cb(oc_factory_presets_cb_t cb, void *data);
......
This diff is collapsed.
......@@ -29,8 +29,6 @@ extern "C"
{
#endif
#define DISCOVERY_CB_PERIOD (60)
/* Used for tracking owned/unowned devices in oc_obt's internal caches */
typedef struct oc_device_t
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment