Removed Doxygen warnings caused by improper formatting of several headers
authorWilliam Dieter <william.r.dieter@intel.com>
Fri, 27 Feb 2015 04:58:06 +0000 (23:58 -0500)
committerSudarshan Prasad <sudarshan.prasad@intel.com>
Thu, 5 Mar 2015 21:32:17 +0000 (21:32 +0000)
commit2c454d7fc6b235f8adc76019305e3e7007bd89cd
treeeeb21d113bafa665e42a0a83740b5e9b5ce52b06
parentcb7c7c974665f1256bf113fe88563c96ec2c05e1
Removed Doxygen warnings caused by improper formatting of several headers

OCResource.h and OCPlatform.h had a number of methods where improperly
documented.  They had:

* Incorrect parameter names for a several methods,

* Missing documentation for overloaded methods,

* Where only one overload was documented, often the documentation was
  attached to the wrong overloaded method,

* Improper capitalization, and

* Formatting that impairs readability of Doxygen HTML documentation.

This commit addresses those issues.

Change-Id: I4536964afe91f4278810fe2d71f0cf74cf7a78b7
Signed-off-by: William Dieter <william.r.dieter@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/417
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
Reviewed-by: Erich Keane <erich.keane@intel.com>
Reviewed-by: Sudarshan Prasad <sudarshan.prasad@intel.com>
resource/include/OCPlatform.h
resource/include/OCResource.h