Fixed doxygen comments in camutex.h

Fixed problems with doxygen comments that included a few causing
outright errors and missing functions in the resulting
documentation.

- Removed use of '@' on local names instead of Doxygen keywords
 which were causing errors.

- Prefixed '::' to types and enums that were not recongnized.

- Fixed typo in enum name

- Added missing periods at end of brief/summary prose.

Change-Id: I2731d9d5ebf10f738e387a1922027fb752a8a3be
Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/1834
Reviewed-by: Erich Keane <erich.keane@intel.com>
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>

diff --git a/resource/csdk/connectivity/common/inc/camutex.h b/resource/csdk/connectivity/common/inc/camutex.h
index be7b085..29d42d8 100644 (file)
--- a/resource/csdk/connectivity/common/inc/camutex.h
+++ b/resource/csdk/connectivity/common/inc/camutex.h
@@ -38,13 +38,13 @@ typedef struct ca_mutex_internal *ca_mutex;
 typedef struct ca_cond_internal *ca_cond;
 
 /**
- * Enums for ca_cond_wait_for return values
+ * Enums for ca_cond_wait_for return values.
  */
 typedef enum
 {
-   CA_WAIT_SUCCESS = 0,    /**< Condition Signal */
-   CA_WAIT_INVAL = -1,     /**< Invalid Condition */
-   CA_WAIT_TIMEDOUT = -2   /**< Condition Timed Out */
+   CA_WAIT_SUCCESS = 0,    /**< Condition Signal. */
+   CA_WAIT_INVAL = -1,     /**< Invalid Condition. */
+   CA_WAIT_TIMEDOUT = -2   /**< Condition Timed Out. */
 } CAWaitResult_t;
 
 /**
@@ -58,7 +58,7 @@ ca_mutex ca_mutex_new(void);
 /**
  * Lock the mutex.
  *
- * @param  mutex  The mutex to be locked
+ * @param  mutex  The mutex to be locked.
  *
  */
 void ca_mutex_lock(ca_mutex mutex);
@@ -66,7 +66,7 @@ void ca_mutex_lock(ca_mutex mutex);
 /**
  * Checks if the mutex can be locked.
  *
- * @param  mutex  The mutex to be locked
+ * @param  mutex  The mutex to be locked.
  *
  * @return  true if the mutex is not locked currently, otherwise false.
  *
@@ -76,7 +76,7 @@ bool ca_mutex_trylock(ca_mutex mutex);
 /**
  * Unlock the mutex.
  *
- * @param  mutex  The mutex to be unlocked
+ * @param  mutex  The mutex to be unlocked.
  *
  */
 void ca_mutex_unlock(ca_mutex mutex);
@@ -84,7 +84,7 @@ void ca_mutex_unlock(ca_mutex mutex);
 /**
  * Free the mutex.
  *
- * @param  mutex  The mutex to be freed
+ * @param  mutex  The mutex to be freed.
  *
  */
 bool ca_mutex_free(ca_mutex mutex);
@@ -92,49 +92,49 @@ bool ca_mutex_free(ca_mutex mutex);
 /**
  * Creates new condition.
  *
- * @return  Reference to newly created @ca_cond, otherwise NULL.
+ * @return  Reference to newly created ::ca_cond, otherwise NULL.
  *
  */
 ca_cond ca_cond_new(void);
 
 /**
- * One of threads is woken up if multiple threads are waiting for @cond.
+ * One of threads is woken up if multiple threads are waiting for cond.
  *
- * @param  cond  The condtion to be signaled
+ * @param  cond  The condtion to be signaled.
  *
  */
 void ca_cond_signal(ca_cond cond);
 
 /**
- * All of threads are woken up if multiple threads are waiting for @cond.
+ * All of threads are woken up if multiple threads are waiting for cond.
  *
- * @param  cond  The condtion to be signaled
+ * @param  cond  The condtion to be signaled.
  *
  */
 void ca_cond_broadcast(ca_cond cond);
 
 /**
- * Waits until this thread woken up on @cond.
+ * Waits until this thread woken up on cond.
  *
- * @param  cond  The condtion to be wait for to signal
- * @param  mutex  The mutex which is currently locked from calling thread
+ * @param  cond  The condtion to be wait for to signal.
+ * @param  mutex  The mutex which is currently locked from calling thread.
  *
  */
 void ca_cond_wait(ca_cond cond, ca_mutex mutex);
 
 /**
- * Waits until this thread woken up on @cond,
+ * Waits until this thread woken up on cond,
  * but not longer than the interval specified by microseconds.
  * The mutex is unlocked before falling asleep and locked again before resuming.
  * If microseconds is 0, ca_cond_wait_for() acts like ca_cond_wait().
  *
- * @param  cond  The condtion to be wait for to signal
- * @param  mutex  The mutex which is currently locked from calling thread
- * @param  microseconds  relative time for waiting, microseconds
+ * @param  cond  The condtion to be wait for to signal.
+ * @param  mutex  The mutex which is currently locked from calling thread.
+ * @param  microseconds  relative time for waiting, microseconds.
  *
- * @return CA_WAIT_SUCCESS if the condition was signaled.
- *         CA_WAIT_TIMEDDOUT if wait period exceeded
- *         CA_WAIT_INVAL for invalid parameters
+ * @return ::CA_WAIT_SUCCESS if the condition was signaled,
+ *         ::CA_WAIT_TIMEDOUT if wait period exceeded,
+ *         ::CA_WAIT_INVAL for invalid parameters.
  *
  */
 CAWaitResult_t ca_cond_wait_for(ca_cond cond, ca_mutex mutex, uint64_t microseconds);
@@ -142,7 +142,7 @@ CAWaitResult_t ca_cond_wait_for(ca_cond cond, ca_mutex mutex, uint64_t microseco
 /**
  * Free the condition.
  *
- * @param  cond  The condition to be freed
+ * @param  cond  The condition to be freed.
  *
  */
 void ca_cond_free(ca_cond cond);
@@ -152,4 +152,3 @@ void ca_cond_free(ca_cond cond);
 #endif /* __cplusplus */
 
 #endif /* CA_MUTEX_H_ */
-