[vala] Documentation fixes



commit 2f14aed36765c842fe7b4035ba564d2c023ef0b0
Author: Didier 'Ptitjes <ptitjes free fr>
Date:   Sat Oct 31 11:03:23 2009 +0100

    Documentation fixes

 vala/valaaddressofexpression.vala         |    2 +-
 vala/valaarraycreationexpression.vala     |    2 +-
 vala/valaconstructor.vala                 |    2 +-
 vala/valadestructor.vala                  |    2 +-
 vala/valalockstatement.vala               |    2 +-
 vala/valamethod.vala                      |    4 ++--
 vala/valanullliteral.vala                 |    2 +-
 vala/valapointerindirection.vala          |    2 +-
 vala/valaproperty.vala                    |    4 ++--
 vala/valareferencetransferexpression.vala |    2 +-
 vala/valatypecheck.vala                   |    2 +-
 vala/valatypesymbol.vala                  |    2 +-
 12 files changed, 14 insertions(+), 14 deletions(-)
---
diff --git a/vala/valaaddressofexpression.vala b/vala/valaaddressofexpression.vala
index 2859a2c..ad00968 100644
--- a/vala/valaaddressofexpression.vala
+++ b/vala/valaaddressofexpression.vala
@@ -23,7 +23,7 @@
 using GLib;
 
 /**
- * Represents an address-of expression in the source code, e.g. `&foo'.
+ * Represents an address-of expression in the source code, e.g. `&foo`.
  */
 public class Vala.AddressofExpression : Expression {
 	/**
diff --git a/vala/valaarraycreationexpression.vala b/vala/valaarraycreationexpression.vala
index a77be1d..34fbd4e 100644
--- a/vala/valaarraycreationexpression.vala
+++ b/vala/valaarraycreationexpression.vala
@@ -25,7 +25,7 @@
 using GLib;
 
 /**
- * Represents an array creation expression e.g. "new int[] {1,2,3}".
+ * Represents an array creation expression e.g. {{{ new int[] {1,2,3} }}}.
  */
 public class Vala.ArrayCreationExpression : Expression {
 	/**
diff --git a/vala/valaconstructor.vala b/vala/valaconstructor.vala
index f61f398..7f89a8f 100644
--- a/vala/valaconstructor.vala
+++ b/vala/valaconstructor.vala
@@ -32,7 +32,7 @@ public class Vala.Constructor : Symbol {
 	public Block body { get; set; }
 	
 	/**
-	 * Specifies the generated `this' parameter for instance methods.
+	 * Specifies the generated `this` parameter for instance methods.
 	 */
 	public FormalParameter this_parameter { get; set; }
 
diff --git a/vala/valadestructor.vala b/vala/valadestructor.vala
index fd4cf42..3f0896c 100644
--- a/vala/valadestructor.vala
+++ b/vala/valadestructor.vala
@@ -32,7 +32,7 @@ public class Vala.Destructor : Symbol {
 	public Block body { get; set; }
 	
 	/**
-	 * Specifies the generated `this' parameter for instance methods.
+	 * Specifies the generated `this` parameter for instance methods.
 	 */
 	public FormalParameter this_parameter { get; set; }
 
diff --git a/vala/valalockstatement.vala b/vala/valalockstatement.vala
index 8f9b5a5..9ad5dfb 100644
--- a/vala/valalockstatement.vala
+++ b/vala/valalockstatement.vala
@@ -23,7 +23,7 @@
 using GLib;
 
 /**
- * Represents a lock statement e.g. "lock (a) { f(a) }".
+ * Represents a lock statement e.g. {{{ lock (a) { f(a) } }}}.
  */
 public class Vala.LockStatement : CodeNode, Statement {
 	/**
diff --git a/vala/valamethod.vala b/vala/valamethod.vala
index 731e9d6..7b0bbe5 100644
--- a/vala/valamethod.vala
+++ b/vala/valamethod.vala
@@ -151,12 +151,12 @@ public class Vala.Method : Member {
 	public bool entry_point { get; private set; }
 
 	/**
-	 * Specifies the generated `this' parameter for instance methods.
+	 * Specifies the generated `this` parameter for instance methods.
 	 */
 	public FormalParameter this_parameter { get; set; }
 
 	/**
-	 * Specifies the generated `result' variable for postconditions.
+	 * Specifies the generated `result` variable for postconditions.
 	 */
 	public LocalVariable result_var { get; set; }
 
diff --git a/vala/valanullliteral.vala b/vala/valanullliteral.vala
index daa7145..a82217d 100644
--- a/vala/valanullliteral.vala
+++ b/vala/valanullliteral.vala
@@ -23,7 +23,7 @@
 using GLib;
 
 /**
- * Represents a literal `null' in the source code.
+ * Represents a literal `null` in the source code.
  */
 public class Vala.NullLiteral : Literal {
 	/**
diff --git a/vala/valapointerindirection.vala b/vala/valapointerindirection.vala
index 42fb54b..fa5b759 100644
--- a/vala/valapointerindirection.vala
+++ b/vala/valapointerindirection.vala
@@ -22,7 +22,7 @@
 
 
 /**
- * Represents a pointer indirection in the source code, e.g. `*pointer'.
+ * Represents a pointer indirection in the source code, e.g. `*pointer`.
  */
 public class Vala.PointerIndirection : Expression {
 	/**
diff --git a/vala/valaproperty.vala b/vala/valaproperty.vala
index 7b79949..e00a21b 100644
--- a/vala/valaproperty.vala
+++ b/vala/valaproperty.vala
@@ -67,12 +67,12 @@ public class Vala.Property : Member, Lockable {
 	}
 	
 	/**
-	 * Represents the generated ´this' parameter in this property.
+	 * Represents the generated `this` parameter in this property.
 	 */
 	public FormalParameter this_parameter { get; set; }
 
 	/**
-	 * Specifies whether a `notify' signal should be emitted on property
+	 * Specifies whether a `notify` signal should be emitted on property
 	 * changes.
 	 */
 	public bool notify { get; set; default = true; }
diff --git a/vala/valareferencetransferexpression.vala b/vala/valareferencetransferexpression.vala
index cc3edd3..e09d06b 100644
--- a/vala/valareferencetransferexpression.vala
+++ b/vala/valareferencetransferexpression.vala
@@ -22,7 +22,7 @@
 
 
 /**
- * Represents a reference transfer expression in the source code, e.g. `#foo'.
+ * Represents a reference transfer expression in the source code, e.g. `#foo`.
  */
 public class Vala.ReferenceTransferExpression : Expression {
 	/**
diff --git a/vala/valatypecheck.vala b/vala/valatypecheck.vala
index 232633f..7097ab8 100644
--- a/vala/valatypecheck.vala
+++ b/vala/valatypecheck.vala
@@ -23,7 +23,7 @@
 using GLib;
 
 /**
- * Represents a type check (`is') expression in the source code.
+ * Represents a type check (`is`) expression in the source code.
  */
 public class Vala.TypeCheck : Expression {
 	/**
diff --git a/vala/valatypesymbol.vala b/vala/valatypesymbol.vala
index f8bc285..b3fd075 100644
--- a/vala/valatypesymbol.vala
+++ b/vala/valatypesymbol.vala
@@ -213,7 +213,7 @@ public abstract class Vala.TypeSymbol : Symbol {
 	 * Returns the default value for the given type. Returning null means
 	 * there is no default value (i.e. not that the default name is NULL).
 	 *
-	 * @return	the name of the default value
+	 * @return the name of the default value
 	 */
 	public virtual string? get_default_value () {
 		return null;



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]