]> git.ipfire.org Git - thirdparty/vala.git/commitdiff
vala: Improve source documentation 120f54f8c8181d4ef9c7294050a4271353dc4b5c
authorRico Tzschichholz <ricotz@ubuntu.com>
Tue, 26 May 2020 08:03:16 +0000 (10:03 +0200)
committerRico Tzschichholz <ricotz@ubuntu.com>
Wed, 27 May 2020 08:23:27 +0000 (10:23 +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 b9ee7b440b21695b5108888f246f16ff84a5f9cf..0f3233422e6b95b795b1b5934faaace17db4a85e 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 8bf42ea261482fa97a6776359a49a4b28ad59ecc..63037528173deb21aacd65c9dd1194e91a52c166 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 68a3cb8f970f9c078cbea0e34f10e00f58dfb2e1..14258af144cd12583a9d3b0c7afb2533a2e3ba40 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 6cac168b2a18e6184396dc355a4f41c61bc2e118..2613a83fb7fe7729eac87d57aea13d2fd1d91a5b 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 40a8c196bb7abb79d36a172d5eecc3131f656b22..3e8d111ad551a65614c9b4ded225f8eecb508af0 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 77a033596526be382bab0cc9147672c8f5091e7f..94fa01578675503d39d461aa0b7394ab2cb8f5c9 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 019003936118ccf342a7c34527b9e6268d285ca3..e46b379d19f2d69c591d2e8c67e14bb052724bea 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 00937bfb26adb25f4fb10bdbbe9113b80f8f9eed..6042d948bf48580aa309a70ce0a1a523b25498a5 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 81fe0ed4fe9e8a823e5c9a0c598876e7f5be52e6..65c579be66ffcd269f3df307150de9dfd101b2b3 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 b1adc63d1f324bacc92413f5853e1713c849310a..a6452df556ba7cc91ee56ea38bac70b7090df035 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 b5ff0e1148dd6f533d5a3d0eea9e28c7acfd0c63..1cfe497c32942aaf2cdd61611bbbc0e41631e671 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 bc8ebcbe446c3b96808238f7567fcac2b87d24e2..84a6a3fbfc8cffa20f9360a44ddeb22c8e36723a 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
         */