Commit 781c3bee authored by George Nash's avatar George Nash Committed by Dan Mihai

Fixed documentation warnings for cpp-docs

Fixed all of the documentation warnings found when running
Doxygen for C++ documentation.

Most of the warnings were due to @param tag not matching
the actual param.

For the copydoc warning foun in OCPlatform the @copydoc
tag was removed because it was not properly copying the
documentation. No clear fix other than actually copying
the documentation.

Change-Id: Ic861ff7dbeb9c7f17d7f39dace05da92f3bb43d1
Signed-off-by: George Nash's avatarGeorge Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/17569Tested-by: default avatarjenkins-iotivity <jenkins@iotivity.org>
Reviewed-by: default avatarDan Mihai <Daniel.Mihai@microsoft.com>
parent c8583dec
......@@ -677,6 +677,7 @@ INPUT = . \
../../../service/easy-setup/mediator/richsdk/inc/ \
../../../service/easy-setup/inc \
../../../service/scene-manager/include \
../../../service/notification/include \
../../../service/notification/cpp-wrapper/provider/inc \
../../../service/notification/cpp-wrapper/consumer/inc \
../../../service/notification/cpp-wrapper/common/NSMediaContents.h \
......
......@@ -595,13 +595,16 @@ namespace OC
* events
*
* @return Returns ::OC_STACK_OK if success.
* @copydoc subscribePresence(OCPresenceHandle&, const std::string&, resourceType, OCConnectivityType, SubscribeCallback)
*/
OCStackResult subscribePresence(OCPresenceHandle& presenceHandle, const std::string& host,
OCConnectivityType connectivityType, SubscribeCallback presenceHandler);
/**
* @overload
*
* subscribes to a server's presence change events. By making this subscription,
* every time a server adds/removes/alters a resource, starts or is intentionally
* stopped (potentially more to be added later).
*
* @param presenceHandle a handle object that can be used to identify this subscription
* request. It can be used to unsubscribe from these events in the future.
* It will be set upon successful return of this method.
......@@ -612,6 +615,7 @@ namespace OC
* interface. Example: CT_DEFAULT, CT_ADAPTER_IP, CT_ADAPTER_TCP.
* @param presenceHandler callback function that will receive notifications/subscription
* events
*
* @see subscribePresence(OCPresenceHandle&, const std::string&, OCConnectivityType, SubscribeCallback)
*/
OCStackResult subscribePresence(OCPresenceHandle& presenceHandle, const std::string& host,
......
......@@ -143,7 +143,7 @@ namespace OC
/**
* API to set the entire resource attribute representation
* @param rep reference to the resource's representation
* @param interface specifies the interface
* @param iface specifies the interface
*/
void setResourceRepresentation(OCRepresentation& rep, std::string iface) {
m_interface = iface;
......@@ -153,7 +153,7 @@ namespace OC
/**
* API to set the entire resource attribute representation
* @param rep rvalue reference to the resource's representation
* @param interface specifies the interface
* @param iface specifies the interface
*/
void setResourceRepresentation(OCRepresentation&& rep, std::string iface) {
setResourceRepresentation(rep, iface);
......
......@@ -85,7 +85,7 @@ namespace OIC
/**
* Constructs an exception with a description.
*
* @param OCStackResult The description for the error.
* @param reason OCStackResult The description for the error.
*/
explicit ESPlatformException(OCStackResult reason);
......@@ -115,7 +115,7 @@ namespace OIC
/**
* Constructs an exception with a description.
*
* @param OCStackResult The description for the error.
* @param what OCStackResult The description for the error.
*/
explicit ESBadRequestException(const std::string& what);
/**
......@@ -134,7 +134,7 @@ namespace OIC
/**
* Constructs an exception with a description.
*
* @param OCStackResult The description for the error.
* @param what OCStackResult The description for the error.
*/
explicit ESInvalidParameterException(const std::string& what);
/**
......@@ -152,7 +152,7 @@ namespace OIC
/**
* Constructs an exception with a description.
*
* @param OCStackResult The description for the error.
* @param what OCStackResult The description for the error.
*/
explicit ESBadGetException(const std::string& what);
/**
......@@ -171,7 +171,7 @@ namespace OIC
/**
* Constructs an exception with a description.
*
* @param OCStackResult The description for the error.
* @param what OCStackResult The description for the error.
*/
explicit ESInvalidKeyException(const std::string& what);
/**
......
......@@ -148,6 +148,7 @@ namespace OIC
/**
* Constructor with OCRepresentation object. This is used for JNI communication.
* @param rep OCRepresentation object
*/
CloudProp(const OCRepresentation &rep)
{
......@@ -344,6 +345,7 @@ namespace OIC
/**
* Constructor with OCRepresentation object. This is used for JNI communication.
* @param rep OCRepresentation object
*/
DeviceProp(const OCRepresentation &rep)
{
......@@ -374,6 +376,7 @@ namespace OIC
*
* @param language IETF language tag using ISO 639X
* @param country ISO Country Code (ISO 3166-1 Alpha-2)
* @param location location information
*/
void setDevConfProp(string language, string country, string location)
{
......@@ -598,7 +601,7 @@ namespace OIC
};
/**
* @breif This provide a set of getter APIs from received response for getConfiguration().
* @brief This provide a set of getter APIs from received response for getConfiguration().
* Received information includes a device name, WiFi supported mode, and frequency.
* Additionally, you can know if Enrollee can be access to cloud server with this
* object.
......
......@@ -51,7 +51,8 @@ namespace OIC
/**
* Constructor of NSTopicsList.
*
* @param topics - pointer to NSTopicLL struct to initialize.
* @param topics pointer to NSTopicLL struct to initialize.
* @param modify indicate if the list is modifiable
*/
NSTopicsList(::NSTopicLL *topics, bool modify);
......
......@@ -71,8 +71,8 @@ namespace OIC
std::shared_ptr<NSProvider> getProvider(const std::string &id);
/**
* request to add NSProvider pointer
* @param shared pointer to NSProvider
* Request to add NSProvider pointer
* @param provider shared pointer to NSProvider
*
*/
void addProvider(std::shared_ptr<NSProvider> provider);
......
......@@ -80,7 +80,7 @@ namespace OIC
/**
* Request to subscribe to remote MQ address as parameter.
* @param[in] server address combined with IP address and port number and MQ broker uri using delimiter :
* @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :
* @param[in] topicName the interest Topic name for subscription.
* @return ::NS_OK or result code of NSResult
*/
......
......@@ -69,8 +69,9 @@ namespace OIC
std::shared_ptr<NSConsumer> getConsumer(const std::string &id);
/**
* request to add NSConsumer pointer
* @param pointer to NSConsumer
* Request to add NSConsumer pointer
*
* @param consumer pointer to NSConsumer
*
*/
void addConsumer(std::shared_ptr<NSConsumer> consumer);
......
......@@ -119,7 +119,7 @@ namespace OIC
/**
* Request to subscribe to remote MQ address as parameter.
* @param[in] server address combined with IP address and port number and MQ broker uri using delimiter :
* @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :
* @param[in] topicName the interest Topic name for subscription.
* @return ::NS_OK or result code of NSResult
*/
......
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