Update documentation for Mutex.withLock to be consistent with Mutex.lock

qwwdfsad · qwwdfsad · commit 23eb49a54af3 · 2019-02-04T12:44:28.000+03:00
Fixes #940
diff --git a/kotlinx-coroutines-core/common/src/sync/Mutex.kt b/kotlinx-coroutines-core/common/src/sync/Mutex.kt
@@ -100,7 +100,8 @@ public fun Mutex(locked: Boolean = false): Mutex =
 /**
  * Executes the given [action] under this mutex's lock.
  *
- * @param owner Optional owner token for debugging.
+ * @param owner Optional owner token for debugging. When `owner` is specified (non-null value) and this mutex
+ *        is already locked with the same token (same identity), this function throws [IllegalStateException].
  *
  * @return the return value of the action.
  */

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,8 @@ public fun Mutex(locked: Boolean = false): Mutex =`
`100`	`100`	`/**`
`101`	`101`	`* Executes the given [action] under this mutex's lock.`
`102`	`102`	`*`
`103`		`- * @param owner Optional owner token for debugging.`
	`103`	+ * @param owner Optional owner token for debugging. When `owner` is specified (non-null value) and this mutex
	`104`	`+ * is already locked with the same token (same identity), this function throws [IllegalStateException].`
`104`	`105`	`*`
`105`	`106`	`* @return the return value of the action.`
`106`	`107`	`*/`