resource-encapsulation: Updated doxygen comments

Updated and fixed some issues w.r.t doxygen comments in resource-encapsulation dir.

Change-Id: I95f61c9d0b99a89a8d72812eb5e2c8c7ff7fe170
Signed-off-by: Ravi Nanjundappa <nravi.n@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/2343
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
Reviewed-by: Uze Choi <uzchoi@samsung.com>

diff --git a/service/resource-encapsulation/include/RCSBundleInfo.h b/service/resource-encapsulation/include/RCSBundleInfo.h
index 9a45524..b18d0d9 100644 (file)
--- a/service/resource-encapsulation/include/RCSBundleInfo.h
+++ b/service/resource-encapsulation/include/RCSBundleInfo.h
@@ -48,7 +48,7 @@ namespace OIC
                 /**
                 * API for setting the Id of the bundle
                 *
-                * @param name - Id of the bundle in string form
+                * @param name Id of the bundle in string form
                 *
                 */
                 virtual void setID(const std::string &name) = 0;
@@ -56,7 +56,7 @@ namespace OIC
                 /**
                 * API for getting the Id of the bundle
                 *
-                * @return string - Id of the bundle
+                * @return Id of the bundle
                 *
                 */
                 virtual const std::string &getID() = 0;
@@ -64,7 +64,7 @@ namespace OIC
                 /**
                 * API for setting the path of the bundle
                 *
-                * @param path - path of the bundle in string form
+                * @param path path of the bundle in string form
                 *
                 */
                 virtual void setPath(const std::string &path) = 0;
@@ -72,7 +72,7 @@ namespace OIC
                 /**
                 * API for getting the path of the bundle
                 *
-                * @return path - path of the bundle
+                * @return path of the bundle
                 *
                 */
                 virtual const std::string &getPath() = 0;
@@ -80,7 +80,7 @@ namespace OIC
                 /**
                 * API for setting the Activator name for the bundle
                 *
-                * @param activator - Activator name in string form
+                * @param activator Activator name in string form
                 *
                 */
                 virtual void setActivatorName(const std::string &activator) = 0;
@@ -88,7 +88,7 @@ namespace OIC
                 /**
                 * API for setting the Activator name for the bundle
                 *
-                * @return string - Name of the activator
+                * @return Name of the activator
                 *
                 */
                 virtual const std::string &getActivatorName() = 0;
@@ -96,7 +96,7 @@ namespace OIC
                 /**
                 * API for setting the library path for the bundle
                 *
-                * @param libpath - Library path in string form
+                * @param libpath Library path in string form
                 *
                 */
                 virtual void setLibraryPath(const std::string &libpath) = 0;
@@ -104,7 +104,7 @@ namespace OIC
                 /**
                 * API for getting the library path for the bundle
                 *
-                * @return string - Library path  in string form
+                * @return Library path  in string form
                 *
                 */
                 virtual const std::string& getLibraryPath() = 0;
@@ -112,7 +112,7 @@ namespace OIC
                 /**
                 * API for setting the version of the bundle
                 *
-                * @param version - version of the bundle in string form
+                * @param version version of the bundle in string form
                 *
                 */
                 virtual void setVersion(const std::string &version) = 0;
@@ -120,7 +120,7 @@ namespace OIC
                 /**
                 * API for getting the version of the bundle
                 *
-                * @return string - version of the bundle
+                * @return version of the bundle
                 *
                 */
                 virtual const std::string &getVersion() = 0;
@@ -128,7 +128,7 @@ namespace OIC
                 /**
                  * API for creating new bundle information
                  *
-                 * @return  RCSBundleInfo - RCSBundleInfo pointer.
+                 * @return RCSBundleInfo pointer.
                  *
                  */
                 static RCSBundleInfo *build();

diff --git a/service/resource-encapsulation/include/RCSDiscoveryManager.h b/service/resource-encapsulation/include/RCSDiscoveryManager.h
index 2105647..ec4a817 100644 (file)
--- a/service/resource-encapsulation/include/RCSDiscoveryManager.h
+++ b/service/resource-encapsulation/include/RCSDiscoveryManager.h
@@ -56,7 +56,7 @@ namespace OIC
                                        ResourceDiscoveredCallback;
 
                 /**
-                 * Returns RCSDiscoveryManager instance.
+                 * @return Returns RCSDiscoveryManager instance.
                  *
                  */
                 static RCSDiscoveryManager* getInstance();

diff --git a/service/resource-encapsulation/include/RCSRemoteResourceObject.h b/service/resource-encapsulation/include/RCSRemoteResourceObject.h
index 0503488..9ba1595 100644 (file)
--- a/service/resource-encapsulation/include/RCSRemoteResourceObject.h
+++ b/service/resource-encapsulation/include/RCSRemoteResourceObject.h
@@ -125,14 +125,14 @@ namespace OIC
             ~RCSRemoteResourceObject();
 
             /**
-             * Returns whether monitoring is enabled.
+             * @return Returns whether monitoring is enabled.
              *
              * @see startMonitoring()
              */
             bool isMonitoring() const;
 
             /**
-             * Returns whether caching is enabled.
+             * @return Returns whether caching is enabled.
              *
              * @see startCaching()
              */
@@ -140,7 +140,7 @@ namespace OIC
             bool isCaching() const;
 
             /**
-             * Returns whether the resource is observable.
+             * @return Returns whether the resource is observable.
              *
              */
             bool isObservable() const;
@@ -177,7 +177,7 @@ namespace OIC
             void stopMonitoring();
 
             /**
-             * Returns the current state of the resource.
+             * @return Returns the current state of the resource.
              *
              * @see startMonitoring
              */
@@ -234,13 +234,13 @@ namespace OIC
             void stopCaching();
 
             /**
-             * Returns the current cache state.
+             * @return Returns the current cache state.
              *
              */
             CacheState getCacheState() const;
 
             /**
-             * Returns whether cached data is available.
+             * @return Returns whether cached data is available.
              *
              * Cache will be available always after CacheState::READY even if current state is
              * CacheState::LOST_SIGNAL.
@@ -317,25 +317,25 @@ namespace OIC
                     RemoteAttributesSetCallback cb);
 
             /**
-             * Returns the uri of the resource.
+             * @return Returns the uri of the resource.
              *
              */
             std::string getUri() const;
 
             /**
-             * Returns the address of the resource .
+             * @return Returns the address of the resource .
              *
              */
             std::string getAddress() const;
 
             /**
-             * Returns the resource types of the resource.
+             * @return Returns the resource types of the resource.
              *
              */
             std::vector< std::string > getTypes() const;
 
             /**
-             * Returns the resource interfaces of the resource.
+             * @return Returns the resource interfaces of the resource.
              *
              */
             std::vector< std::string > getInterfaces() const;

diff --git a/service/resource-encapsulation/include/RCSRequest.h b/service/resource-encapsulation/include/RCSRequest.h
index 6b531db..907c9f6 100644 (file)
--- a/service/resource-encapsulation/include/RCSRequest.h
+++ b/service/resource-encapsulation/include/RCSRequest.h
@@ -42,14 +42,14 @@ namespace OIC
                 /**
                 * Constructor to set resource URI.
                 *
-                * @param resourceUri - URI of the resource for which the request is generated.
+                * @param resourceUri URI of the resource for which the request is generated.
                 */
                 explicit RCSRequest(const std::string &resourceUri);
 
                 RCSRequest &operator=(RCSRequest &) = delete;
 
                 /**
-                * Returns the URI of the request.
+                * @return Returns the URI of the request.
                 *
                 */
                 std::string getResourceUri() const;

diff --git a/service/resource-encapsulation/include/RCSResourceContainer.h b/service/resource-encapsulation/include/RCSResourceContainer.h
index cab5aa3..1cc72ed 100644 (file)
--- a/service/resource-encapsulation/include/RCSResourceContainer.h
+++ b/service/resource-encapsulation/include/RCSResourceContainer.h
@@ -63,7 +63,7 @@ namespace OIC
                  *
                  * @details This API start the container with the provided Configuration file.
                  *
-                 * @param configFile - configuration File that contains the Bundle/Bundles information.
+                 * @param configFile configuration File that contains the Bundle/Bundles information.
                  *
                  */
                 virtual void startContainer(const std::string &configFile) = 0;
@@ -76,21 +76,21 @@ namespace OIC
                 /**
                 * API for getting the list of all bundles in the container
                 *
-                * @return  list<BundleInfo*> -List of BundleInfo pointer each associated with a bundle
+                * @return List of BundleInfo pointer each associated with a bundle
                 *
                 */
                 virtual std::list<RCSBundleInfo *> listBundles() = 0;
                 /**
                  * API for starting the bundle.
                  *
-                 * @param bundleId - Id of the Bundle
+                 * @param bundleId Id of the Bundle
                  *
                  */
                 virtual void startBundle(const std::string &bundleId) = 0;
                 /**
                 * API for Stopping the bundle
                 *
-                * @param bundleId - Id of the Bundle
+                * @param bundleId Id of the Bundle
                 *
                 */
                 virtual void stopBundle(const std::string &bundleId) = 0;
@@ -99,10 +99,10 @@ namespace OIC
                 /**
                  * API for adding the bundle to the Container
                  *
-                 * @param bundleId - Id of the Bundle
-                 * @param bundleUri - Uri of the bundle
-                 * @param bundlePath - Path of the bundle
-                 * @param params  - key-value pairs in string form for other Bundle parameters
+                 * @param bundleId Id of the Bundle
+                 * @param bundleUri Uri of the bundle
+                 * @param bundlePath Path of the bundle
+                 * @param params  key-value pairs in string form for other Bundle parameters
                  *
                  */
                 virtual void addBundle(const std::string &bundleId, const std::string &bundleUri, const std::string &bundlePath,
@@ -110,7 +110,7 @@ namespace OIC
                 /**
                  * API for removing the bundle from the container
                  *
-                 * @param bundleId - Id of the Bundle
+                 * @param bundleId Id of the Bundle
                  *
                  */
                 virtual void removeBundle(const std::string &bundleId) = 0;
@@ -118,9 +118,9 @@ namespace OIC
                 /**
                 * API for adding the Resource configuration information to the bundle
                 *
-                * @param bundleId - Id of the Bundle
-                * @param resourceUri - URI of the resource
-                * @param params  - key-value pairs in string form for other Bundle parameters
+                * @param bundleId Id of the Bundle
+                * @param resourceUri URI of the resource
+                * @param params key-value pairs in string form for other Bundle parameters
                 *
                 */
                 virtual void addResourceConfig(const std::string &bundleId, const std::string &esourceUri,
@@ -128,8 +128,8 @@ namespace OIC
                 /**
                 * API for removing the Resource configuration information from the bundle
                 *
-                * @param bundleId - Id of the Bundle
-                * @param resourceUri - URI of the resource
+                * @param bundleId Id of the Bundle
+                * @param resourceUri URI of the resource
                 *
                 */
                 virtual void removeResourceConfig(const std::string &bundleId, const std::string &resourceUri) = 0;
@@ -137,7 +137,7 @@ namespace OIC
                 /**
                 * API for getting the list of Bundle Resources
                 *
-                * @param bundleId - Id of the Bundle
+                * @param bundleId Id of the Bundle
                 *
                 */
                 virtual std::list<std::string> listBundleResources(const std::string &bundleId) = 0;
@@ -145,7 +145,7 @@ namespace OIC
                 /**
                  * API for getting the Instance of ResourceContainer class
                  *
-                 * @return RCSResourceContainer - Instance of the "RCSResourceContainer" class
+                 * @return Instance of the "RCSResourceContainer" class
                  *
                  */
                 static RCSResourceContainer *getInstance();

diff --git a/service/resource-encapsulation/include/RCSResponse.h b/service/resource-encapsulation/include/RCSResponse.h
index afe6c10..43a8e40 100644 (file)
--- a/service/resource-encapsulation/include/RCSResponse.h
+++ b/service/resource-encapsulation/include/RCSResponse.h
@@ -263,7 +263,7 @@ namespace OIC
             /**
              * Sets the acceptance method for the RCSSetResponse.
              *
-             * @param method - AcceptanceMethod value to set
+             * @param method AcceptanceMethod value to set
              *
              * @return The reference to this RCSSetResponse
              *