[thread] Canonicalize order of library descriptive elements

Author: jensmaurer

source/threads.tex

@@ -2162,18 +2162,18 @@
 \effects
 Blocks the calling thread until ownership of the mutex can be obtained for the calling thread.
 
+\pnum
+\sync
+Prior \tcode{unlock()} operations on the same object
+\term{synchronize with}\iref{intro.multithread} this operation.
+
 \pnum
 \ensures
 The calling thread owns the mutex.
 
 \pnum
 \returntype \tcode{void}.
 
-\pnum
-\sync
-Prior \tcode{unlock()} operations on the same object
-\term{synchronize with}\iref{intro.multithread} this operation.
-
 \pnum
 \throws
 \tcode{system_error} when
@@ -2214,13 +2214,6 @@
 An implementation should ensure that \tcode{try_lock()} does not consistently return \tcode{false}
 in the absence of contending mutex acquisitions.
 
-\pnum
-\returntype \tcode{bool}.
-
-\pnum
-\returns
-\tcode{true} if ownership was obtained, otherwise \tcode{false}.
-
 \pnum
 \sync
 If \tcode{try_lock()} returns \tcode{true}, prior \tcode{unlock()} operations
@@ -2231,6 +2224,13 @@
 known about the state after a failure, even in the absence of spurious failures.
 \end{note}
 
+\pnum
+\returntype \tcode{bool}.
+
+\pnum
+\returns
+\tcode{true} if ownership was obtained, otherwise \tcode{false}.
+
 \pnum
 \throws
 Nothing.
@@ -2415,18 +2415,18 @@
 lock is available, but implementations are expected to make a strong effort to do so.
 \end{note}
 
+\pnum
+\sync
+If \tcode{try_lock_for()} returns \tcode{true}, prior \tcode{unlock()} operations
+on the same object \term{synchronize with}\iref{intro.multithread} this operation.
+
 \pnum
 \returntype \tcode{bool}.
 
 \pnum
 \returns
 \tcode{true} if ownership was obtained, otherwise \tcode{false}.
 
-\pnum
-\sync
-If \tcode{try_lock_for()} returns \tcode{true}, prior \tcode{unlock()} operations
-on the same object \term{synchronize with}\iref{intro.multithread} this operation.
-
 \pnum
 \throws
 Timeout-related exceptions\iref{thread.req.timing}.
@@ -2456,19 +2456,19 @@
 strong effort to do so.
 \end{note}
 
+\pnum
+\sync
+If \tcode{try_lock_until()} returns \tcode{true}, prior \tcode{unlock()}
+operations on the same object \term{synchronize with}\iref{intro.multithread}
+this operation.
+
 \pnum
 \returntype \tcode{bool}.
 
 \pnum
 \returns
 \tcode{true} if ownership was obtained, otherwise \tcode{false}.
 
-\pnum
-\sync
-If \tcode{try_lock_until()} returns \tcode{true}, prior \tcode{unlock()}
-operations on the same object \term{synchronize with}\iref{intro.multithread}
-this operation.
-
 \pnum
 \throws
 Timeout-related exceptions\iref{thread.req.timing}.
@@ -2634,17 +2634,17 @@
 Blocks the calling thread until shared ownership of the mutex can be obtained for the calling thread.
 If an exception is thrown then a shared lock has not been acquired for the current thread.
 
+\pnum
+\sync
+Prior \tcode{unlock()} operations on the same object synchronize with\iref{intro.multithread} this operation.
+
 \pnum
 \ensures
 The calling thread has a shared lock on the mutex.
 
 \pnum
 \returntype \tcode{void}.
 
-\pnum
-\sync
-Prior \tcode{unlock()} operations on the same object synchronize with\iref{intro.multithread} this operation.
-
 \pnum
 \throws
 \tcode{system_error} when an exception is required\iref{thread.req.exception}.
@@ -2697,19 +2697,19 @@
 effect and \tcode{try_lock_shared()} immediately returns. An implementation
 may fail to obtain the lock even if it is not held by any other thread.
 
+\pnum
+\sync
+If \tcode{try_lock_shared()} returns \tcode{true}, prior \tcode{unlock()}
+operations on the same object synchronize with\iref{intro.multithread} this
+operation.
+
 \pnum
 \returntype \tcode{bool}.
 
 \pnum
 \returns
 \tcode{true} if the shared lock was acquired, otherwise \tcode{false}.
 
-\pnum
-\sync
-If \tcode{try_lock_shared()} returns \tcode{true}, prior \tcode{unlock()}
-operations on the same object synchronize with\iref{intro.multithread} this
-operation.
-
 \pnum
 \throws
 Nothing.
@@ -2811,19 +2811,19 @@
 If an exception is thrown then a shared lock has not been acquired for
 the current thread.
 
+\pnum
+\sync
+If \tcode{try_lock_shared_for()} returns \tcode{true}, prior
+\tcode{unlock()} operations on the same object synchronize
+with\iref{intro.multithread} this operation.
+
 \pnum
 \returntype \tcode{bool}.
 
 \pnum
 \returns
 \tcode{true} if the shared lock was acquired, otherwise \tcode{false}.
 
-\pnum
-\sync
-If \tcode{try_lock_shared_for()} returns \tcode{true}, prior
-\tcode{unlock()} operations on the same object synchronize
-with\iref{intro.multithread} this operation.
-
 \pnum
 \throws
 Timeout-related exceptions\iref{thread.req.timing}.
@@ -2854,19 +2854,19 @@
 If an exception is thrown then a shared lock has not been acquired for
 the current thread.
 
+\pnum
+\sync
+If \tcode{try_lock_shared_until()} returns \tcode{true}, prior
+\tcode{unlock()} operations on the same object synchronize
+with\iref{intro.multithread} this operation.
+
 \pnum
 \returntype \tcode{bool}.
 
 \pnum
 \returns
 \tcode{true} if the shared lock was acquired, otherwise \tcode{false}.
 
-\pnum
-\sync
-If \tcode{try_lock_shared_until()} returns \tcode{true}, prior
-\tcode{unlock()} operations on the same object synchronize
-with\iref{intro.multithread} this operation.
-
 \pnum
 \throws
 Timeout-related exceptions\iref{thread.req.timing}.
@@ -6363,11 +6363,6 @@
 \end{itemdecl}
 
 \begin{itemdescr}
-\pnum
-\returns
-A \tcode{future<R>} object with the same shared state as
-\tcode{*this}.
-
 \pnum
 \sync
 Calls to this function do not introduce
@@ -6380,6 +6375,11 @@
 Such calls need not synchronize with each other.
 \end{note}
 
+\pnum
+\returns
+A \tcode{future<R>} object with the same shared state as
+\tcode{*this}.
+
 \pnum
 \throws
 \tcode{future_error} if \tcode{*this} has no shared state or if
@@ -7275,16 +7275,6 @@
 in this document nor by the implementation, the behavior is undefined.
 \end{itemize}
 
-\pnum
-\returns
-An object of type
-\tcode{future<invoke_result_t<decay_t<F>, decay_t<Args>...>>} that refers
-to the shared state created by this call to \tcode{async}.
-\begin{note}
-If a future obtained from \tcode{async} is moved outside the local scope,
-the future's destructor can block for the shared state to become ready.
-\end{note}
-
 \pnum
 \sync
 The invocation of \tcode{async} synchronizes with the invocation of \tcode{f}.
@@ -7315,6 +7305,16 @@
 happens first.
 \end{itemize}
 
+\pnum
+\returns
+An object of type
+\tcode{future<invoke_result_t<decay_t<F>, decay_t<Args>...>>} that refers
+to the shared state created by this call to \tcode{async}.
+\begin{note}
+If a future obtained from \tcode{async} is moved outside the local scope,
+the future's destructor can block for the shared state to become ready.
+\end{note}
+
 \pnum
 \throws
 \tcode{system_error} if \tcode{policy == launch::async} and the
@@ -7551,10 +7551,6 @@
 \end{itemdecl}
 
 \begin{itemdescr}
-\pnum
-\returns
-A \tcode{future} object that shares the same shared state as \tcode{*this}.
-
 \pnum
 \sync
 Calls to this function do not introduce
@@ -7565,6 +7561,10 @@
 Such calls need not synchronize with each other.
 \end{note}
 
+\pnum
+\returns
+A \tcode{future} object that shares the same shared state as \tcode{*this}.
+
 \pnum
 \throws
 A \tcode{future_error} object if an error occurs.