summaryrefslogtreecommitdiff
path: root/vala/valalockstatement.vala
diff options
context:
space:
mode:
authorRico Tzschichholz <ricotz@ubuntu.com>2020-05-26 10:03:16 +0200
committerRico Tzschichholz <ricotz@ubuntu.com>2020-05-27 10:23:27 +0200
commit120f54f8c8181d4ef9c7294050a4271353dc4b5c (patch)
treeaf00e4e4217c72e79bd4e0eda85fdf3c81ab3794 /vala/valalockstatement.vala
parent48679761c7298f14bdab9c6ea3bd4c48db192cf5 (diff)
downloadvala-120f54f8c8181d4ef9c7294050a4271353dc4b5c.tar.gz
vala: Improve source documentation
Diffstat (limited to 'vala/valalockstatement.vala')
-rw-r--r--vala/valalockstatement.vala10
1 files changed, 6 insertions, 4 deletions
diff --git a/vala/valalockstatement.vala b/vala/valalockstatement.vala
index 81fe0ed4f..65c579be6 100644
--- a/vala/valalockstatement.vala
+++ b/vala/valalockstatement.vala
@@ -26,11 +26,13 @@
using GLib;
/**
- * Represents a lock statement e.g. {{{ lock (a); }}} or {{{ lock (a) { f(a); } }}}.
+ * Represents a lock statement.
*
- * If the statement is empty, the mutex remains locked until a corresponding UnlockStatement
- * occurs. Otherwise it's translated into a try/finally statement which unlocks the mutex
- * after the block is finished.
+ * {{{ lock (foo); }}} or {{{ lock (foo) { ... } }}}
+ *
+ * If the statement is empty, the mutex remains locked until a corresponding
+ * {@link Vala.UnlockStatement} occurs. Otherwise it's translated into a
+ * try/finally statement which unlocks the mutex after the block is finished.
*/
public class Vala.LockStatement : CodeNode, Statement {
/**