Skip to content

Fix @param names in synchronized_value #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
karpovantonme wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fix @param names in synchronized_value #420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions include/boost/thread/synchronized_value.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ namespace boost
BOOST_THREAD_MOVABLE_ONLY( const_strict_lock_ptr )

/**
* @param value constant reference of the value to protect.
* @param val constant reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @effects locks the mutex @c mtx, stores a reference to it and to the value type @c value.
*/
Expand Down Expand Up @@ -116,7 +116,7 @@ namespace boost
BOOST_THREAD_MOVABLE_ONLY( strict_lock_ptr )

/**
* @param value reference of the value to protect.
* @param val reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @effects locks the mutex @c mtx, stores a reference to it and to the value type @c value.
*/
Expand Down Expand Up @@ -204,7 +204,7 @@ namespace boost
BOOST_THREAD_MOVABLE_ONLY(const_unique_lock_ptr)

/**
* @param value reference of the value to protect.
* @param val reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
*
* @requires If mutex_type is not a recursive mutex the calling thread does not own the mutex.
Expand All @@ -216,9 +216,9 @@ namespace boost
{
}
/**
* @param value reference of the value to protect.
* @param val reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @param tag of type adopt_lock_t used to differentiate the constructor.
* @note the unnamed third argument of type adopt_lock_t selects this constructor.
* @requires The calling thread own the mutex.
* @effects stores a reference to it and to the value type @c value taking ownership.
*/
Expand All @@ -227,19 +227,19 @@ namespace boost
{
}
/**
* @param value reference of the value to protect.
* @param val reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @param tag of type defer_lock_t used to differentiate the constructor.
* @note the unnamed third argument of type defer_lock_t selects this constructor.
* @effects stores a reference to it and to the value type @c value c.
*/
const_unique_lock_ptr(T const& val, Lockable & mtx, defer_lock_t) BOOST_NOEXCEPT
: base_type(mtx, defer_lock), value_(val)
{
}
/**
* @param value reference of the value to protect.
* @param val reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @param tag of type try_to_lock_t used to differentiate the constructor.
* @note the unnamed third argument of type try_to_lock_t selects this constructor.
* @requires If mutex_type is not a recursive mutex the calling thread does not own the mutex.
* @effects try to lock the mutex @c mtx, stores a reference to it and to the value type @c value.
*/
Expand Down Expand Up @@ -300,7 +300,7 @@ namespace boost
BOOST_THREAD_MOVABLE_ONLY(unique_lock_ptr)

/**
* @param value reference of the value to protect.
* @param val reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @effects locks the mutex @c mtx, stores a reference to it and to the value type @c value.
*/
Expand All @@ -311,7 +311,7 @@ namespace boost
/**
* @param value reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @param tag of type adopt_lock_t used to differentiate the constructor.
* @note the unnamed third argument of type adopt_lock_t selects this constructor.
* @effects stores a reference to it and to the value type @c value taking ownership.
*/
unique_lock_ptr(T & value, Lockable & mtx, adopt_lock_t) BOOST_NOEXCEPT
Expand All @@ -321,7 +321,7 @@ namespace boost
/**
* @param value reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @param tag of type defer_lock_t used to differentiate the constructor.
* @note the unnamed third argument of type defer_lock_t selects this constructor.
* @effects stores a reference to it and to the value type @c value c.
*/
unique_lock_ptr(T & value, Lockable & mtx, defer_lock_t) BOOST_NOEXCEPT
Expand All @@ -331,7 +331,7 @@ namespace boost
/**
* @param value reference of the value to protect.
* @param mtx reference to the mutex used to protect the value.
* @param tag of type try_to_lock_t used to differentiate the constructor.
* @note the unnamed third argument of type try_to_lock_t selects this constructor.
* @effects try to lock the mutex @c mtx, stores a reference to it and to the value type @c value.
*/
unique_lock_ptr(T & value, Lockable & mtx, try_to_lock_t) BOOST_NOEXCEPT
Expand Down