Commit 509ab072 authored by Éric Thiébaut's avatar Éric Thiébaut
Browse files

Fix doc.

parent fb6590f7
......@@ -114,8 +114,8 @@ extern tao_status tao_mutex_try_lock(
* @param abstime Absolute time limit for waiting.
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds; @ref TAO_TIMEOUT if timeout occurred
* before; @ref TAO_ERROR in case of failure.
* specified time limit; @ref TAO_TIMEOUT if timeout occurred before;
* @ref TAO_ERROR in case of failure.
*
* @see tao_mutex_lock(), tao_mutex_try_lock(), tao_mutex_timed_lock(),
* tao_status.
......@@ -139,8 +139,8 @@ extern tao_status tao_mutex_abstimed_lock(
* calling tao_mutex_try_lock().
*
* @return @ref TAO_OK if the read/write lock has been locked for reading by
* the caller before the specified number of seconds; @ref TAO_TIMEOUT
* if timeout occurred before; @ref TAO_ERROR in case of failure.
* the caller before the specified time limit; @ref TAO_TIMEOUT if
* timeout occurred before; @ref TAO_ERROR in case of failure.
*
* @see tao_mutex_lock(), tao_mutex_try_lock(), tao_get_absolute_timeout(),
* tao_mutex_abstimed_lock(), tao_status.
......
......@@ -234,8 +234,8 @@ extern tao_status tao_remote_camera_try_lock(
* @param lim Absolute time limit.
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_camera_abstimed_lock(
tao_remote_camera* cam,
......@@ -260,8 +260,8 @@ extern tao_status tao_remote_camera_abstimed_lock(
* calling tao_remote_camera_try_lock().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_camera_timed_lock(
tao_remote_camera* cam,
......@@ -339,8 +339,8 @@ extern tao_status tao_remote_camera_wait_condition(
* tao_get_current_time().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_camera_abstimed_wait_condition(
tao_remote_camera* cam,
......@@ -362,8 +362,8 @@ extern tao_status tao_remote_camera_abstimed_wait_condition(
* tao_remote_camera_wait_condition().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_camera_timed_wait_condition(
tao_remote_camera* cam,
......
......@@ -267,8 +267,8 @@ extern tao_status tao_remote_mirror_try_lock(
* @param lim Absolute time limit.
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_mirror_abstimed_lock(
tao_remote_mirror* obj,
......@@ -293,8 +293,8 @@ extern tao_status tao_remote_mirror_abstimed_lock(
* calling tao_remote_mirror_try_lock().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_mirror_timed_lock(
tao_remote_mirror* obj,
......@@ -372,8 +372,8 @@ extern tao_status tao_remote_mirror_wait_condition(
* tao_get_current_time().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_mirror_abstimed_wait_condition(
tao_remote_mirror* obj,
......@@ -395,8 +395,8 @@ extern tao_status tao_remote_mirror_abstimed_wait_condition(
* tao_remote_mirror_wait_condition().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_mirror_timed_wait_condition(
tao_remote_mirror* obj,
......
......@@ -328,8 +328,8 @@ extern tao_status tao_remote_object_try_lock(
* @param lim Absolute time limit.
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_object_abstimed_lock(
tao_remote_object* obj,
......@@ -354,8 +354,8 @@ extern tao_status tao_remote_object_abstimed_lock(
* calling tao_remote_object_try_lock().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_object_timed_lock(
tao_remote_object* obj,
......@@ -433,8 +433,8 @@ extern tao_status tao_remote_object_wait_condition(
* tao_get_current_time().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_object_abstimed_wait_condition(
tao_remote_object* obj,
......@@ -456,8 +456,8 @@ extern tao_status tao_remote_object_abstimed_wait_condition(
* tao_remote_object_wait_condition().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_remote_object_timed_wait_condition(
tao_remote_object* obj,
......
......@@ -174,8 +174,8 @@ extern tao_status tao_shared_camera_try_rdlock(
* calling tao_shared_camera_try_rdlock().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_shared_camera_abstimed_rdlock(
tao_shared_camera* cam,
......
......@@ -318,8 +318,8 @@ extern tao_status tao_shared_object_try_lock(
* @param lim Absolute time limit.
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_shared_object_abstimed_lock(
tao_shared_object* obj,
......@@ -344,7 +344,7 @@ extern tao_status tao_shared_object_abstimed_lock(
* calling tao_shared_object_try_lock().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* specified time limit, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
*/
extern tao_status tao_shared_object_timed_lock(
......@@ -423,8 +423,8 @@ extern tao_status tao_shared_object_wait_condition(
* tao_get_current_time().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_shared_object_abstimed_wait_condition(
tao_shared_object* obj,
......@@ -446,8 +446,8 @@ extern tao_status tao_shared_object_abstimed_wait_condition(
* tao_shared_object_wait_condition().
*
* @return @ref TAO_OK if the lock has been locked by the caller before the
* specified number of seconds, @ref TAO_TIMEOUT if timeout occurred
* before or @ref TAO_ERROR in case of error.
* specified time limit, @ref TAO_TIMEOUT if timeout occurred before or
* @ref TAO_ERROR in case of error.
*/
extern tao_status tao_shared_object_timed_wait_condition(
tao_shared_object* obj,
......
Supports Markdown
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