Updated and fixed some issues w.r.t doxygen comments in things-manager dir.
Change-Id: I3b872c2720f7723fd84c9f317c60f7785906806f
Signed-off-by: Ravi Nanjundappa <nravi.n@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/3841
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
typedef std::function< void(const HeaderOptions&, const OCRepresentation&, const int) > PutCallback;
/**
- * @class GroupManager
- * @brief
* This APIs provide functions for application to find appropriate devices (i.e. things) in network,
* create a group of the devices, check a presence of member devices in the group, and actuate a
* group action in a more convenient way.
* @param callback callback with OCResource vector.
* @param waitsec time to wait to finish finding resources
*
- * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
*
- * NOTE: OCStackResult is defined in ocstack.h.
+ * @note OCStackResult is defined in ocstack.h.
*/
OCStackResult findCandidateResources(std::vector< std::string > resourceTypes,
CandidateCallback callback, int waitsec = -1);
/**
* API for Collection member's state subscribe.
*
- * NOTE: NOT IMPLEMENT YET
+ * @note NOT IMPLEMENT YET
*/
OCStackResult subscribeCollectionPresence(std::shared_ptr< OCResource > resource,
CollectionPresenceCallback);
*
* @return std::string return value of this API.
* It returns an action set String.
- * @note OCStackResult is defined in ocstack.h.
*/
std::string getStringFromActionSet(const ActionSet *newActionSet);
* @param newActionSet pointer of ActionSet class instance
* @param cb callback for PUT operation.
*
- * @return Returns ::OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
*
* @note OCStackResult is defined in ocstack.h.
*/
* @param actionsetName the action set name for executing the action set
* @param cb callback for POST operation.
*
- * @return Returns ::OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
* @note OCStackResult is defined in ocstack.h.
*/
OCStackResult executeActionSet(std::shared_ptr< OCResource > resource,
* @param delay waiting time for until the action set run.
* @param cb callback for POST operation.
*
- * @return Returns ::OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
* @note OCStackResult is defined in ocstack.h.
*/
OCStackResult executeActionSet(std::shared_ptr< OCResource > resource,
* @param actionsetName the action set name for executing the action set
* @param cb callback for POST operation.
*
- * @return Returns ::OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
* @note OCStackResult is defined in ocstack.h.
*/
OCStackResult cancelActionSet(std::shared_ptr< OCResource > resource,
* @param actionsetName the action set name for reading the action set
* @param cb callback for GET operation.
*
- * @return Returns ::OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
* @note OCStackResult is defined in ocstack.h.
*/
OCStackResult getActionSet(std::shared_ptr< OCResource > resource, std::string actionsetName,
* @param actionsetName the action set name for removing the action set
* @param cb callback for POST operation.
*
- * @return Returns ::OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
* @note OCStackResult is defined in ocstack.h.
*/
OCStackResult deleteActionSet(std::shared_ptr< OCResource > resource, std::string actionsetName,
typedef std::string ConfigurationValue;
/**
- * @brief
* The following class is used as a item stacking in request queue. The class stores a request
* and referential information (e.g., a configuration name, a target resource object, a callback
* function passed from the applications, and a update value). When the function for updating/
};
/**
- * @brief
* The following class is used to store providing configuration name and its relevant
* information. The relevant information includes a brief description, uri, and attribute key.
* Note that a developer only specifies a configuration name, not URI nor attribute key, to
typedef std::string ConfigurationValue;
/**
- * @class ThingsConfiguration
- * @brief
- * There are two main usages of this class: (1) On a server side, bootstrapping requisite
- * information (i.e. system configuration parameters) from a bootstrap server to access other
- * IoT services, (2) On a client side, getting/updating the system configuration parameters
- * from/to multiple remote things.
+ * @par There are two main usages of this class:
+ * -# On a server side, bootstrapping requisite information (i.e. system configuration parameters)
+ * from a bootstrap server to access other IoT services,
+ * -# On a client side, getting/updating the system configuration parameters from/to multiple remote things.
+ * @par
*/
class ThingsConfiguration
{
* by Things Configuration class and what the configuration name means.
* To get a list of supported configuration names, use getListOfSupportedConfigurationUnits(
* ) function, which provides the list in JSON format.
+ *
* NOTICE: A series of callback functions is called from updateConfigurations() function:
- * (1) For a collection resource
+ * @par
+ * -# For a collection resource
* updateConfiguration()->onDeleteActionSet()->onGetChildInfoForUpdate()->onCreateActionSet(
* )->...(CoAP msg. is transmitted)->OnExecuteForGroupAction()->callback function in APP.
- * (2) For a simple resource
+ * -# For a simple resource
* updateConfiguration()->...(CoAP msg. is transmitted)->OnPut()->callback function in APP.
+ * @par
*
- * @param resource - resource pointer representing the target group or the single thing.
- * @param configurations - ConfigurationUnit: an attribute key of target resource
+ * @param resource resource pointer representing the target group or the single thing.
+ * @param configurations ConfigurationUnit: an attribute key of target resource
* (e.g., loc, st, c, r)
* Value : a value to be updated
- * @param callback - callback.
+ * @param callback callback.
*
- * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
*
- * NOTE: OCStackResult is defined in ocstack.h.
+ * @note OCStackResult is defined in ocstack.h.
*/
OCStackResult updateConfigurations(std::shared_ptr< OCResource > resource,
std::map< ConfigurationName, ConfigurationValue > configurations,
* API for getting configuration value of multiple things of a target group or a single
* thing.
* Callback is called when a response arrives.
+ *
* NOTICE: A series of callback functions is called from getConfigurations() function:
- * (1) For a collection resource
+ * @par
+ * -# For a collection resource
* getConfigurations()->onGetChildInfoForGet()->...(CoAP msg. is transmitted)
* ->callback function in APP.
- * (2) For a simple resource
+ * -# For a simple resource
* getConfigurations()->...(CoAP msg. is transmitted)->onGet()->callback function in APP.
+ * @par
*
- * @param resource - resource pointer representing the target group or the single thing.
- * @param configurations - ConfigurationUnit: an attribute key of target resource.
- * @param callback - callback.
+ * @param resource resource pointer representing the target group or the single thing.
+ * @param configurations ConfigurationUnit: an attribute key of target resource.
+ * @param callback callback.
*
- * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
*
- * NOTE: OCStackResult is defined in ocstack.h.
+ * @note OCStackResult is defined in ocstack.h.
*/
OCStackResult getConfigurations(std::shared_ptr< OCResource > resource,
std::vector< ConfigurationName > configurations, ConfigurationCallback callback);
* information from the bootstrap server. With the information, make a configuration
* resource.
*
- * @param callback - callback.
+ * @param callback callback.
*
- * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
*
- * NOTE: OCStackResult is defined in ocstack.h.
+ * @note OCStackResult is defined in ocstack.h.
*/
OCStackResult doBootstrap(ConfigurationCallback callback);
> MaintenanceCallback;
/**
- * @brief
* The following class is used as a item stacking in request queue. The class stores a request
* and referential information (e.g., a maintenance name, a target resource object, a callback
* function passed from the applications, and a update value). When the function for updating/
};
/**
- * @brief
* The following class is used to store providing maintenance name and its relevant information
* The relevant information includes a brief description, uri, and attribute key.
* Note that a developer only specifies a maintenance name, not URI nor attribute key, to
typedef std::string MaintenanceValue;
/**
- * @class ThingsMaintenance
- * @brief
- * There are two functionalities in Things Maintenance; (1) FactoryReset to restore all
- * configuration parameters to default one, and (2) Reboot to request a system rebooting.
+ * There are two functionalities in Things Maintenance;
+ * @par
+ * -# FactoryReset to restore all configuration parameters to default one, and
+ * -# Reboot to request a system rebooting.
+ * @par
+ *
*/
class ThingsMaintenance
{
* API to make things reboot
* Callback call when a response arrives.
*
- * @param resource - resource pointer representing the target group
- * @param callback - callback.
+ * @param resource resource pointer representing the target group
+ * @param callback callback.
*
- * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
*
- * NOTE: OCStackResult is defined in ocstack.h.
+ * @note OCStackResult is defined in ocstack.h.
*/
OCStackResult reboot(std::shared_ptr< OCResource > resource, MaintenanceCallback callback);
* API for factory reset on device
* Callback call when a response arrives.
*
- * @param resource - resource pointer representing the target group
- * @param callback - callback.
+ * @param resource resource pointer representing the target group
+ * @param callback callback.
*
- * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
+ * @return Returns ::OC_STACK_OK if success, some other value upon failure.
*
- * NOTE: OCStackResult is defined in ocstack.h.
+ * @note OCStackResult is defined in ocstack.h.
*/
OCStackResult factoryReset(std::shared_ptr< OCResource > resource,
projects / platform / upstream / iotivity.git / commitdiff