]> git.ipfire.org Git - thirdparty/vala.git/commitdiff
vala: Improve source documentation
authorRico Tzschichholz <ricotz@ubuntu.com>
Tue, 26 May 2020 08:03:16 +0000 (10:03 +0200)
committerRico Tzschichholz <ricotz@ubuntu.com>
Mon, 22 Jun 2020 08:19:53 +0000 (10:19 +0200)
16 files changed:
vala/valaaddressofexpression.vala
vala/valaarraycreationexpression.vala
vala/valabaseaccess.vala
vala/valadeletestatement.vala
vala/valaelementaccess.vala
vala/valaenumvalue.vala
vala/valaerrorcode.vala
vala/valaforeachstatement.vala
vala/valainterface.vala
vala/valalambdaexpression.vala
vala/valalockstatement.vala
vala/valapointerindirection.vala
vala/valareferencetransferexpression.vala
vala/valasliceexpression.vala
vala/valaunlockstatement.vala
vala/valayieldstatement.vala

index 4948a46c2a4ea6f03ab804a540ffb8b9ad4db3aa..5f5da6a84aacfea37e603b1058cb7f473a1f6580 100644 (file)
@@ -23,7 +23,9 @@
 using GLib;
 
 /**
- * Represents an address-of expression in the source code, e.g. `&foo`.
+ * Represents an address-of expression.
+ *
+ * {{{ &foo }}}
  */
 public class Vala.AddressofExpression : Expression {
        /**
index ebd7aa19e2789e42a850b15377ac16e0fbce1536..71683cf4ed50a2a2c2f6ed190d183a89a85353ab 100644 (file)
@@ -25,7 +25,9 @@
 using GLib;
 
 /**
- * Represents an array creation expression e.g. {{{ new int[] {1,2,3} }}}.
+ * Represents an array creation expression.
+ *
+ * {{{ new int[] { 1, 2, 3 } }}}
  */
 public class Vala.ArrayCreationExpression : Expression {
        /**
index ed81935072e0a2f8d701ee39bf01433cbe17edc9..450c876017bd2248ca0ec16e4d30a234f8bc0075 100644 (file)
@@ -22,7 +22,7 @@
 
 
 /**
- * Represents an access to base class members in the source code.
+ * Represents an access to base type member in the source code.
  */
 public class Vala.BaseAccess : Expression {
        /**
index eb1d9215054a1342b2655733021ad338b9d2a296..8d8996725b9f18b63caa08cb2e2f9c0c728daf60 100644 (file)
@@ -21,7 +21,9 @@
  */
 
 /**
- * Represents a delete statement e.g. "delete a".
+ * Represents a delete statement.
+ *
+ * {{{ delete foo; }}}
  */
 public class Vala.DeleteStatement : CodeNode, Statement {
        /**
index 08844e0f7274c0ddb49abc0aa8eeab00a00718fd..7c1f01b2e798fb06bdc750b37530583e84e0a366 100644 (file)
@@ -25,7 +25,9 @@
 using GLib;
 
 /**
- * Represents an array access expression e.g. "a[1,2]".
+ * Represents an array access expression.
+ *
+ * {{{ foo[1,2] }}}
  */
 public class Vala.ElementAccess : Expression {
        /**
index 1352e6b031fe7ba3c77ab6d50993eb82a39cfb20..e0129d2a7a474c989ab1c4d4f535c534a0806cbc 100644 (file)
@@ -23,7 +23,7 @@
 using GLib;
 
 /**
- * Represents an enum member in the source code.
+ * Represents an enum value member in the source code.
  */
 public class Vala.EnumValue : Constant {
        /**
index 3e3c57b3758d39569db847f96aa81c97596ff3f4..525fb7d556d7e7e68c143b33e83efb9512d59cc8 100644 (file)
@@ -23,7 +23,7 @@
 using GLib;
 
 /**
- * Represents an enum member in the source code.
+ * Represents an error value member in the source code.
  */
 public class Vala.ErrorCode : TypeSymbol {
        /**
index 5159c2b3f2679300c09ccb3d3e0041df60721c69..1ae237cf75d4a8b7a8f561985b45e17a25c5027e 100644 (file)
@@ -22,8 +22,9 @@
 
 
 /**
- * Represents a foreach statement in the source code. Foreach statements iterate
- * over the elements of a collection.
+ * Represents a foreach statement in the source code.
+ *
+ * Foreach statements iterate over the elements of a collection.
  */
 public class Vala.ForeachStatement : Block {
        /**
index 3a3a28cadf87fe4b5d9396c7d757c7a8d990e29f..190a48ca52422c1f198144faf281b479d2cc60c6 100644 (file)
@@ -23,7 +23,7 @@
 using GLib;
 
 /**
- * Represents a class declaration in the source code.
+ * Represents an interface declaration in the source code.
  */
 public class Vala.Interface : ObjectTypeSymbol {
        private List<DataType> prerequisites = new ArrayList<DataType> ();
index d47e7f0e3b8e61d74229c4dd184646963a69649c..abf490b298673e5efab8f154bfc38352975438da 100644 (file)
@@ -23,8 +23,9 @@
 using GLib;
 
 /**
- * Represents a lambda expression in the source code. Lambda expressions are
- * anonymous methods with implicitly typed parameters.
+ * Represents a lambda expression in the source code.
+ *
+ * Lambda expressions are anonymous methods with implicitly typed parameters.
  */
 public class Vala.LambdaExpression : Expression {
        private static int next_lambda_id = 0;
index e64d4a206956eb3fab99c2b8a9b7116cb08c75ea..c9cc96e7c7a509a5d0b4b8ba15c05997db61c103 100644 (file)
 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 {
        /**
index 5e99b9dc01964352917d5bd835a373c82b1020ca..156194cb833bfe064a3296164ed35e0f126f20e3 100644 (file)
@@ -22,7 +22,9 @@
 
 
 /**
- * Represents a pointer indirection in the source code, e.g. `*pointer`.
+ * Represents a pointer indirection.
+ *
+ * {{{ *foo }}}
  */
 public class Vala.PointerIndirection : Expression {
        /**
index f9b4289979db1fcadb8ca15f54fc622729248522..35dd9b9826bd0e51af5942925f079d1b644f85be 100644 (file)
@@ -22,7 +22,9 @@
 
 
 /**
- * Represents a reference transfer expression in the source code, e.g. `#foo`.
+ * Represents a reference transfer expression.
+ *
+ * {{{ (owned) foo }}}
  */
 public class Vala.ReferenceTransferExpression : Expression {
        /**
index 5637330315f0c63a096b42ec6511c25b8f449c58..83acd69d7172ec19677eee2ae59281ed507dc112 100644 (file)
@@ -25,7 +25,9 @@
 using GLib;
 
 /**
- * Represents an array slice expression e.g "a[1:5]".
+ * Represents an array slice expression.
+ *
+ * {{{ foo[1:5] }}}
  */
 public class Vala.SliceExpression : Expression {
        public Expression container {
index d60d5706c5439a4b211137804162c2a527852e34..b40d800575420686fedd39a0e636c3b312682280 100644 (file)
@@ -22,7 +22,9 @@
  */
 
 /**
- * Represents an unlock statement e.g. {{{ unlock (a); }}}.
+ * Represents an unlock statement.
+ *
+ * {{{ unlock (foo); }}}
  */
 public class Vala.UnlockStatement : CodeNode, Statement {
        /**
index 91d8e7f9f67acdea4514c7dbb2644a84ab38a21d..7148f3b7432f499731649705179f25bcd5f6d090 100644 (file)
@@ -27,7 +27,6 @@ public class Vala.YieldStatement : CodeNode, Statement {
        /**
         * Creates a new yield statement.
         *
-        * @param yield_expression the yield expression
         * @param source_reference reference to source code
         * @return                 newly created yield statement
         */