Revision: 65596
http://sourceforge.net/p/brlcad/code/65596
Author: starseeker
Date: 2015-07-12 15:27:08 +0000 (Sun, 12 Jul 2015)
Log Message:
-----------
Clear clang Wdocumentation warnings
Modified Paths:
--------------
brlcad/trunk/src/librt/primitives/bot/gct_decimation/auxiliary/tinycthread.h
Modified:
brlcad/trunk/src/librt/primitives/bot/gct_decimation/auxiliary/tinycthread.h
===================================================================
---
brlcad/trunk/src/librt/primitives/bot/gct_decimation/auxiliary/tinycthread.h
2015-07-12 15:20:52 UTC (rev 65595)
+++
brlcad/trunk/src/librt/primitives/bot/gct_decimation/auxiliary/tinycthread.h
2015-07-12 15:27:08 UTC (rev 65596)
@@ -200,7 +200,7 @@
* @li @c mtx_timed for a non-recursive mutex that supports timeout
* @li @c mtx_plain | @c mtx_recursive (same as @c mtx_plain, but recursive)
* @li @c mtx_timed | @c mtx_recursive (same as @c mtx_timed, but recursive)
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int mtx_init(mtx_t *mtx, int type);
@@ -215,7 +215,7 @@
* the calling thread already has a lock on the mutex, this call will block
* forever.
* @param mtx A mutex object.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int mtx_lock(mtx_t *mtx);
@@ -228,7 +228,7 @@
* The specified mutex shall support either test and return or timeout. If the
* mutex is already locked, the function returns without blocking.
* @param mtx A mutex object.
-* @return @ref thrd_success on success, or @ref thrd_busy if the resource
+* @return thrd_success on success, or thrd_busy if the resource
* requested is already in use, or @ref thrd_error if the request could not be
* honored.
*/
@@ -236,7 +236,7 @@
/** Unlock the given mutex.
* @param mtx A mutex object.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int mtx_unlock(mtx_t *mtx);
@@ -254,7 +254,7 @@
/** Create a condition variable object.
* @param cond A condition variable object.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int cnd_init(cnd_t *cond);
@@ -269,7 +269,7 @@
* at the time of the call. If no threads are blocked on the condition variable
* at the time of the call, the function does nothing and return success.
* @param cond A condition variable object.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int cnd_signal(cnd_t *cond);
@@ -279,7 +279,7 @@
* at the time of the call. If no threads are blocked on the condition variable
* at the time of the call, the function does nothing and return success.
* @param cond A condition variable object.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int cnd_broadcast(cnd_t *cond);
@@ -291,7 +291,7 @@
* before it returns.
* @param cond A condition variable object.
* @param mtx A mutex object.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int cnd_wait(cnd_t *cond, mtx_t *mtx);
@@ -303,8 +303,8 @@
* becomes unblocked it locks the mutex before it returns.
* @param cond A condition variable object.
* @param mtx A mutex object.
-* @param xt A point in time at which the request will time out (absolute time).
-* @return @ref thrd_success upon success, or @ref thrd_timeout if the time
+* @param ts A point in time at which the request will time out (absolute time).
+* @return thrd_success upon success, or thrd_timeout if the time
* specified in the call was reached without acquiring the requested resource,
or
* @ref thrd_error if the request could not be honored.
*/
@@ -332,7 +332,7 @@
* @param func A function pointer to the function that will be executed in
* the new thread.
* @param arg An argument to the thread function.
-* @return @ref thrd_success on success, or @ref thrd_nomem if no memory could
+* @return thrd_success on success, or thrd_nomem if no memory could
* be allocated for the thread requested, or @ref thrd_error if the request
* could not be honored.
* @note A thread’s identifier may be reused for a different thread once the
@@ -369,7 +369,7 @@
* @param thr The thread to join with.
* @param res If this pointer is not NULL, the function will store the result
* code of the given thread in the integer pointed to by @c res.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int thrd_join(thrd_t thr, int *res);
@@ -409,7 +409,7 @@
* @param key The unique key identifier that will be set if the function is
* successful.
* @param dtor Destructor function. This can be NULL.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
* @note On Windows, the @c dtor will definitely be called when
* appropriate for threads created with @ref thrd_create. It will be
@@ -437,7 +437,7 @@
* @param key The thread-specific storage identifier.
* @param val The value of the thread-specific storage to set for the current
* thread.
-* @return @ref thrd_success on success, or @ref thrd_error if the request could
+* @return thrd_success on success, or thrd_error if the request could
* not be honored.
*/
int tss_set(tss_t key, void *val);
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Don't Limit Your Business. Reach for the Cloud.
GigeNET's Cloud Solutions provide you with the tools and support that
you need to offload your IT needs and focus on growing your business.
Configured For All Businesses. Start Your Cloud Today.
https://www.gigenetcloud.com/
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
