Fixed documentation warnings for c-docs 43/17543/6
authorGeorge Nash <george.nash@intel.com>
Tue, 28 Feb 2017 00:00:02 +0000 (16:00 -0800)
committerDan Mihai <Daniel.Mihai@microsoft.com>
Sat, 4 Mar 2017 19:56:29 +0000 (19:56 +0000)
commit3040f83ffa0e030cfce2261c391155935a9c5976
tree7705d306c673685faa9fe24d9c4fe6bc02d53aa3
parent5343a1b86221b54a5513dc68b055c00e53318cef
Fixed documentation warnings for c-docs

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

All of the documentation warnings fell into 3 areas:
1. Error using the @param[in,out] syntax
2. @param did not match the actual parameter name
3. Paramerter was missing documentation all together

For  case 3 an attempt to provide the best documentation
was done based on context. In a few situations the parameter
documentation is just restating the type of parameter being
passed in.

Change-Id: I06797a471dcefaaa2d9b50dc44ca4228cfafb941
Signed-off-by: George Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/17543
Tested-by: jenkins-iotivity <jenkins@iotivity.org>
Reviewed-by: Dan Mihai <Daniel.Mihai@microsoft.com>
19 files changed:
resource/c_common/ocrandom/include/ocrandom.h
resource/csdk/connectivity/api/cainterface.h
resource/csdk/connectivity/api/cautilinterface.h
resource/csdk/resource-directory/include/RDClient.h
resource/csdk/routing/include/routingmanager.h
resource/csdk/routing/include/routingmessageparser.h
resource/csdk/routing/include/routingtablemanager.h
resource/csdk/routing/include/routingutility.h
resource/csdk/stack/include/internal/ocobserve.h
resource/csdk/stack/include/internal/ocresource.h
resource/csdk/stack/include/internal/ocresourcehandler.h
resource/csdk/stack/include/internal/ocserverrequest.h
resource/csdk/stack/include/internal/ocstackinternal.h
resource/csdk/stack/include/ocpayload.h
resource/csdk/stack/include/ocstack.h
resource/docs/c-doc/Doxyfile
resource/docs/cpp-doc/Doxyfile
service/notification/include/NSConsumerInterface.h
service/notification/include/NSProviderInterface.h