Fix parameter names in the documentation for libvala

Fixes bug 755917

31 files changed, 100 insertions, 105 deletions

diff --git a/vala/valaattribute.vala b/vala/valaattribute.vala
index a3ce48b17..5486f4f2a 100644
--- a/vala/valaattribute.vala
+++ b/vala/valaattribute.vala
@@ -51,7 +51,8 @@ public class Vala.Attribute : CodeNode {
 	/**
 	 * Adds an attribute argument.
 	 *
-	 * @param arg named argument
+	 * @param key    argument name
+	 * @param value  argument value
 	 */
 	public void add_argument (string key, string value) {
 		args.set (key, value);
diff --git a/vala/valabinaryexpression.vala b/vala/valabinaryexpression.vala
index 0c9bf3243..e57ebb4d6 100644
--- a/vala/valabinaryexpression.vala
+++ b/vala/valabinaryexpression.vala
@@ -66,11 +66,11 @@ public class Vala.BinaryExpression : Expression {
 	/**
 	 * Creates a new binary expression.
 	 *
-	 * @param op     binary operator
-	 * @param left   left operand
-	 * @param right  right operand
-	 * @param source reference to source code
-	 * @return       newly created binary expression
+	 * @param op      binary operator
+	 * @param _left   left operand
+	 * @param _right  right operand
+	 * @param source  reference to source code
+	 * @return        newly created binary expression
 	 */
 	public BinaryExpression (BinaryOperator op, Expression _left, Expression _right, SourceReference? source = null) {
 		operator = op;
diff --git a/vala/valablock.vala b/vala/valablock.vala
index de8a62ab3..4064b6e90 100644
--- a/vala/valablock.vala
+++ b/vala/valablock.vala
@@ -41,7 +41,7 @@ public class Vala.Block : Symbol, Statement {
 	/**
 	 * Creates a new block.
 	 *
-	 * @param source reference to source code
+	 * @param source_reference  reference to source code
 	 */
 	public Block (SourceReference? source_reference) {
 		base (null, source_reference);
@@ -85,7 +85,7 @@ public class Vala.Block : Symbol, Statement {
 	/**
 	 * Add a local variable to this block.
 	 *
-	 * @param decl a variable declarator
+	 * @param local a variable declarator
 	 */
 	public void add_local_variable (LocalVariable local) {
 		var parent_block = parent_symbol;
diff --git a/vala/valacastexpression.vala b/vala/valacastexpression.vala
index c7a72b6f2..36edb73c2 100644
--- a/vala/valacastexpression.vala
+++ b/vala/valacastexpression.vala
@@ -63,9 +63,9 @@ public class Vala.CastExpression : Expression {
 	/**
 	 * Creates a new cast expression.
 	 *
-	 * @param inner expression to be cast
-	 * @param type  target type
-	 * @return      newly created cast expression
+	 * @param inner           expression to be cast
+	 * @param type_reference  target type
+	 * @return                newly created cast expression
 	 */
 	public CastExpression (Expression inner, DataType type_reference, SourceReference source_reference, bool is_silent_cast) {
 		this.type_reference = type_reference;
diff --git a/vala/valacatchclause.vala b/vala/valacatchclause.vala
index 59a28e209..84e4ba340 100644
--- a/vala/valacatchclause.vala
+++ b/vala/valacatchclause.vala
@@ -76,9 +76,9 @@ public class Vala.CatchClause : CodeNode {
 	private LocalVariable _error_variable;
 
 	/**
-	 * Creates a new catch 
+	 * Creates a new catch
 	 *
-	 * @param type_reference   error type
+	 * @param error_type       error type
 	 * @param variable_name    error variable name
 	 * @param body             error handler body
 	 * @param source_reference reference to source code
diff --git a/vala/valaclass.vala b/vala/valaclass.vala
index 12a82afd0..085f0ddb0 100644
--- a/vala/valaclass.vala
+++ b/vala/valaclass.vala
@@ -209,10 +209,10 @@ public class Vala.Class : ObjectTypeSymbol {
 	/**
 	 * Creates a new class.
 	 *
-	 * @param name   type name
-	 * @param source reference to source code
-	 * @param comment class documentation
-	 * @return       newly created class
+	 * @param name             type name
+	 * @param source_reference reference to source code
+	 * @param comment          class documentation
+	 * @return                 newly created class
 	 */
 	public Class (string name, SourceReference? source_reference = null, Comment? comment = null) {
 		base (name, source_reference, comment);
diff --git a/vala/valacodecontext.vala b/vala/valacodecontext.vala
index 612ca2aab..1fe23b6dd 100644
--- a/vala/valacodecontext.vala
+++ b/vala/valacodecontext.vala
@@ -212,8 +212,6 @@ public class Vala.CodeContext {
 
 	/**
 	 * The root namespace of the symbol tree.
-	 *
-	 * @return root namespace
 	 */
 	public Namespace root {
 		get { return _root; }
diff --git a/vala/valadeclarationstatement.vala b/vala/valadeclarationstatement.vala
index c4c778f21..f0a3d4161 100644
--- a/vala/valadeclarationstatement.vala
+++ b/vala/valadeclarationstatement.vala
@@ -45,9 +45,9 @@ public class Vala.DeclarationStatement : CodeNode, Statement {
 	/**
 	 * Creates a new declaration statement.
 	 *
-	 * @param decl   local variable declaration
-	 * @param source reference to source code
-	 * @return       newly created declaration statement
+	 * @param declaration       local variable declaration
+	 * @param source_reference  reference to source code
+	 * @return                  newly created declaration statement
 	 */
 	public DeclarationStatement (Symbol declaration, SourceReference? source_reference) {
 		this.declaration = declaration;
diff --git a/vala/valadelegate.vala b/vala/valadelegate.vala
index d949c611f..73af358fc 100644
--- a/vala/valadelegate.vala
+++ b/vala/valadelegate.vala
@@ -71,10 +71,10 @@ public class Vala.Delegate : TypeSymbol {
 	/**
 	 * Creates a new delegate.
 	 *
-	 * @param name        delegate type name
-	 * @param return_type return type
-	 * @param source      reference to source code
-	 * @return            newly created delegate
+	 * @param name              delegate type name
+	 * @param return_type       return type
+	 * @param source_reference  reference to source code
+	 * @return                  newly created delegate
 	 */
 	public Delegate (string? name, DataType return_type, SourceReference? source_reference = null, Comment? comment = null) {
 		base (name, source_reference, comment);
diff --git a/vala/valadostatement.vala b/vala/valadostatement.vala
index 6bf72c0c7..c368b5b28 100644
--- a/vala/valadostatement.vala
+++ b/vala/valadostatement.vala
@@ -58,10 +58,10 @@ public class Vala.DoStatement : CodeNode, Statement {
 	/**
 	 * Creates a new do statement.
 	 *
-	 * @param cond   loop condition
-	 * @param body   loop body
-	 * @param source reference to source code
-	 * @return       newly created do statement
+	 * @param body              loop body
+	 * @param condition         loop condition
+	 * @param source_reference  reference to source code
+	 * @return                  newly created do statement
 	 */
 	public DoStatement (Block body, Expression condition, SourceReference? source_reference = null) {
 		this.condition = condition;
diff --git a/vala/valaexpressionstatement.vala b/vala/valaexpressionstatement.vala
index 6d01a985b..912e5d91a 100644
--- a/vala/valaexpressionstatement.vala
+++ b/vala/valaexpressionstatement.vala
@@ -44,9 +44,9 @@ public class Vala.ExpressionStatement : CodeNode, Statement {
 	/**
 	 * Creates a new expression statement.
 	 *
-	 * @param expr   expression to evaluate
-	 * @param source reference to source code
-	 * @return       newly created expression statement
+	 * @param expression        expression to evaluate
+	 * @param source_reference  reference to source code
+	 * @return                  newly created expression statement
 	 */
 	public ExpressionStatement (Expression expression, SourceReference? source_reference = null) {
 		this.source_reference = source_reference;
diff --git a/vala/valafield.vala b/vala/valafield.vala
index d447e8026..e54cbd175 100644
--- a/vala/valafield.vala
+++ b/vala/valafield.vala
@@ -43,11 +43,11 @@ public class Vala.Field : Variable, Lockable {
 	/**
 	 * Creates a new field.
 	 *
-	 * @param name   field name
-	 * @param type   field type
-	 * @param init   initializer expression
-	 * @param source reference to source code
-	 * @return       newly created field
+	 * @param name              field name
+	 * @param variable_type     field type
+	 * @param initializer       initializer expression
+	 * @param source_reference  reference to source code
+	 * @return                  newly created field
 	 */
 	public Field (string name, DataType variable_type, Expression? initializer, SourceReference? source_reference = null, Comment? comment = null) {
 		base (variable_type, name, initializer, source_reference, comment);
diff --git a/vala/valaforeachstatement.vala b/vala/valaforeachstatement.vala
index 8c6522229..4de3f52bd 100644
--- a/vala/valaforeachstatement.vala
+++ b/vala/valaforeachstatement.vala
@@ -95,11 +95,12 @@ public class Vala.ForeachStatement : Block {
 	/**
 	 * Creates a new foreach statement.
 	 *
-	 * @param type   element type
-	 * @param id     element variable name
-	 * @param col    loop body
-	 * @param source reference to source code
-	 * @return       newly created foreach statement
+	 * @param type_reference    element type
+	 * @param variable_name     element variable name
+	 * @param collection        container
+	 * @param body              loop body
+	 * @param source_reference  reference to source code
+	 * @return                  newly created foreach statement
 	 */
 	public ForeachStatement (DataType? type_reference, string variable_name, Expression collection, Block body, SourceReference source_reference) {
 		base (source_reference);
diff --git a/vala/valaforstatement.vala b/vala/valaforstatement.vala
index 555dc623c..ab80af520 100644
--- a/vala/valaforstatement.vala
+++ b/vala/valaforstatement.vala
@@ -63,7 +63,7 @@ public class Vala.ForStatement : CodeNode, Statement {
 	/**
 	 * Creates a new for statement.
 	 *
-	 * @param cond             loop condition
+	 * @param condition        loop condition
 	 * @param body             loop body
 	 * @param source_reference reference to source code
 	 * @return                 newly created for statement
diff --git a/vala/valainterface.vala b/vala/valainterface.vala
index 92eee4e32..43c6f5cae 100644
--- a/vala/valainterface.vala
+++ b/vala/valainterface.vala
@@ -80,9 +80,9 @@ public class Vala.Interface : ObjectTypeSymbol {
 	/**
 	 * Creates a new interface.
 	 *
-	 * @param name   type name
-	 * @param source reference to source code
-	 * @return       newly created interface
+	 * @param name              type name
+	 * @param source_reference  reference to source code
+	 * @return                  newly created interface
 	 */
 	public Interface (string name, SourceReference? source_reference = null, Comment? comment = null) {
 		base (name, source_reference, comment);
diff --git a/vala/valalocalvariable.vala b/vala/valalocalvariable.vala
index 7c1222421..a7979f747 100644
--- a/vala/valalocalvariable.vala
+++ b/vala/valalocalvariable.vala
@@ -36,10 +36,10 @@ public class Vala.LocalVariable : Variable {
 	/**
 	 * Creates a new local variable.
 	 *
-	 * @param name   name of the variable
-	 * @param init   optional initializer expression
-	 * @param source reference to source code
-	 * @return       newly created variable declarator
+	 * @param name              name of the variable
+	 * @param initializer       optional initializer expression
+	 * @param source_reference  reference to source code
+	 * @return                  newly created variable declarator
 	 */
 	public LocalVariable (DataType? variable_type, string name, Expression? initializer = null, SourceReference? source_reference = null) {
 		base (variable_type, name, initializer, source_reference);
diff --git a/vala/valaloop.vala b/vala/valaloop.vala
index 5782070f9..4e6edbe63 100644
--- a/vala/valaloop.vala
+++ b/vala/valaloop.vala
@@ -44,9 +44,9 @@ public class Vala.Loop : CodeNode, Statement {
 	/**
 	 * Creates a new loop.
 	 *
-	 * @param body   loop body
-	 * @param source reference to source code
-	 * @return       newly created while statement
+	 * @param body             loop body
+	 * @param source_reference reference to source code
+	 * @return                 newly created while statement
 	 */
 	public Loop (Block body, SourceReference? source_reference = null) {
 		this.body = body;
diff --git a/vala/valamethod.vala b/vala/valamethod.vala
index 2dc7c8007..d9aba3e6c 100644
--- a/vala/valamethod.vala
+++ b/vala/valamethod.vala
@@ -206,10 +206,10 @@ public class Vala.Method : Subroutine {
 	/**
 	 * Creates a new method.
 	 *
-	 * @param name        method name
-	 * @param return_type method return type
-	 * @param source      reference to source code
-	 * @return            newly created method
+	 * @param name              method name
+	 * @param return_type       method return type
+	 * @param source_reference  reference to source code
+	 * @return                  newly created method
 	 */
 	public Method (string? name, DataType return_type, SourceReference? source_reference = null, Comment? comment = null) {
 		base (name, source_reference, comment);
diff --git a/vala/valaparameter.vala b/vala/valaparameter.vala
index 2a89e6991..b55374c37 100644
--- a/vala/valaparameter.vala
+++ b/vala/valaparameter.vala
@@ -52,10 +52,10 @@ public class Vala.Parameter : Variable {
 	/**
 	 * Creates a new formal parameter.
 	 *
-	 * @param name   parameter name
-	 * @param type   parameter type
-	 * @param source reference to source code
-	 * @return       newly created formal parameter
+	 * @param name              parameter name
+	 * @param variable_type     parameter type
+	 * @param source_reference  reference to source code
+	 * @return                  newly created formal parameter
 	 */
 	public Parameter (string name, DataType? variable_type, SourceReference? source_reference = null) {
 		base (variable_type, name, null, source_reference);
diff --git a/vala/valapostfixexpression.vala b/vala/valapostfixexpression.vala
index 5f44157b9..2c829b468 100644
--- a/vala/valapostfixexpression.vala
+++ b/vala/valapostfixexpression.vala
@@ -47,10 +47,10 @@ public class Vala.PostfixExpression : Expression {
 	/**
 	 * Creates a new postfix expression.
 	 *
-	 * @param inner  operand expression
-	 * @param inc    true for increment, false for decrement
-	 * @param source reference to source code
-	 * @return newly created postfix expression
+	 * @param _inner  operand expression
+	 * @param inc     true for increment, false for decrement
+	 * @param source  reference to source code
+	 * @return newly  created postfix expression
 	 */
 	public PostfixExpression (Expression _inner, bool inc, SourceReference source) {
 		inner = _inner;
diff --git a/vala/valaproperty.vala b/vala/valaproperty.vala
index 8a8ced49b..9da3508ea 100644
--- a/vala/valaproperty.vala
+++ b/vala/valaproperty.vala
@@ -157,12 +157,12 @@ public class Vala.Property : Symbol, Lockable {
 	/**
 	 * Creates a new property.
 	 *
-	 * @param name         property name
-	 * @param type         property type
-	 * @param get_accessor get accessor
-	 * @param set_accessor set/construct accessor
-	 * @param source       reference to source code
-	 * @return             newly created property
+	 * @param name              property name
+	 * @param property_type     property type
+	 * @param get_accessor      get accessor
+	 * @param set_accessor      set/construct accessor
+	 * @param source_reference  reference to source code
+	 * @return                  newly created property
 	 */
 	public Property (string name, DataType? property_type, PropertyAccessor? get_accessor, PropertyAccessor? set_accessor, SourceReference? source_reference = null, Comment? comment = null) {
 		base (name, source_reference, comment);
diff --git a/vala/valapropertyaccessor.vala b/vala/valapropertyaccessor.vala
index f29a04672..5a91b3fcd 100644
--- a/vala/valapropertyaccessor.vala
+++ b/vala/valapropertyaccessor.vala
@@ -81,12 +81,12 @@ public class Vala.PropertyAccessor : Subroutine {
 	/**
 	 * Creates a new property accessor.
 	 *
-	 * @param readable     true if get accessor, false otherwise
-	 * @param writable     true if set accessor, false otherwise
-	 * @param construction true if construct accessor, false otherwise
-	 * @param body         accessor body
-	 * @param source       reference to source code
-	 * @return             newly created property accessor
+	 * @param readable           true if get accessor, false otherwise
+	 * @param writable           true if set accessor, false otherwise
+	 * @param construction       true if construct accessor, false otherwise
+	 * @param body               accessor body
+	 * @param source_reference   reference to source code
+	 * @return                   newly created property accessor
 	 */
 	public PropertyAccessor (bool readable, bool writable, bool construction, DataType? value_type, Block? body, SourceReference? source_reference, Comment? comment = null) {
 		base (null, source_reference, comment);
diff --git a/vala/valaregexliteral.vala b/vala/valaregexliteral.vala
index f91aa1a22..79270fa60 100644
--- a/vala/valaregexliteral.vala
+++ b/vala/valaregexliteral.vala
@@ -35,9 +35,9 @@ public class Vala.RegexLiteral : Literal {
 	/**
 	 * Creates a new regular expression literal.
 	 *
-	 * @param s      the literal value
-	 * @param source reference to source code
-	 * @return       newly created string literal
+	 * @param value             the literal value
+	 * @param source_reference  reference to source code
+	 * @return                  newly created string literal
 	 */
 	public RegexLiteral (string value, SourceReference? source_reference = null) {
 		this.value = value;
diff --git a/vala/valasignal.vala b/vala/valasignal.vala
index 3ddc453b3..6b05a0926 100644
--- a/vala/valasignal.vala
+++ b/vala/valasignal.vala
@@ -68,10 +68,10 @@ public class Vala.Signal : Symbol, Lockable {
 	/**
 	 * Creates a new signal.
 	 *
-	 * @param name        signal name
-	 * @param return_type signal return type
-	 * @param source      reference to source code
-	 * @return            newly created signal
+	 * @param name              signal name
+	 * @param return_type       signal return type
+	 * @param source_reference  reference to source code
+	 * @return                  newly created signal
 	 */
 	public Signal (string name, DataType return_type, SourceReference? source_reference = null, Comment? comment = null) {
 		base (name, source_reference, comment);
diff --git a/vala/valasourcefile.vala b/vala/valasourcefile.vala
index e925a6ba2..0126b1671 100644
--- a/vala/valasourcefile.vala
+++ b/vala/valasourcefile.vala
@@ -99,7 +99,6 @@ public class Vala.SourceFile {
 	 * Creates a new source file.
 	 *
 	 * @param filename source file name
-	 * @param pkg      true if this is a VAPI package file
 	 * @return         newly created source file
 	 */
 	public SourceFile (CodeContext context, SourceFileType type, string filename, string? content = null, bool cmdline = false) {
diff --git a/vala/valasourcereference.vala b/vala/valasourcereference.vala
index be2f6ad7f..ffacd5253 100644
--- a/vala/valasourcereference.vala
+++ b/vala/valasourcereference.vala
@@ -46,11 +46,9 @@ public class Vala.SourceReference {
 	/**
 	 * Creates a new source reference.
 	 *
-	 * @param file         a source file
-	 * @param first_line   first line number
-	 * @param first_column first column number
-	 * @param last_line    last line number
-	 * @param last_column  last column number
+	 * @param _file        a source file
+	 * @param begin        the begin of the referenced source code
+	 * @param end          the end of the referenced source code
 	 * @return             newly created source reference
 	 */
 	public SourceReference (SourceFile _file, SourceLocation begin, SourceLocation end) {
diff --git a/vala/valastringliteral.vala b/vala/valastringliteral.vala
index ffb4285be..e54a9c424 100644
--- a/vala/valastringliteral.vala
+++ b/vala/valastringliteral.vala
@@ -36,9 +36,9 @@ public class Vala.StringLiteral : Literal {
 	/**
 	 * Creates a new string literal.
 	 *
-	 * @param s      the literal value
-	 * @param source reference to source code
-	 * @return       newly created string literal
+	 * @param value             the literal value
+	 * @param source_reference  reference to source code
+	 * @return                  newly created string literal
 	 */
 	public StringLiteral (string value, SourceReference? source_reference = null) {
 		this.value = value;
diff --git a/vala/valastruct.vala b/vala/valastruct.vala
index dbbf62992..21985d7af 100644
--- a/vala/valastruct.vala
+++ b/vala/valastruct.vala
@@ -376,8 +376,6 @@ public class Vala.Struct : TypeSymbol {
 
 	/**
 	 * Sets the rank of this integer or floating point type.
-	 *
-	 * @return the rank if this is an integer or floating point type
 	 */
 	public void set_rank (int rank) {
 		this.rank = rank;
diff --git a/vala/valatypeparameter.vala b/vala/valatypeparameter.vala
index 62540b364..9912175a9 100644
--- a/vala/valatypeparameter.vala
+++ b/vala/valatypeparameter.vala
@@ -29,10 +29,10 @@ public class Vala.TypeParameter : Symbol {
 	/**
 	 * Creates a new generic type parameter.
 	 *
-	 * @param name   parameter name
-	 * @param source reference to source code
-	 * @return       newly created generic type parameter
-	 */	
+	 * @param name              parameter name
+	 * @param source_reference  reference to source code
+	 * @return                  newly created generic type parameter
+	 */
 	public TypeParameter (string name, SourceReference source_reference) {
 		base (name, source_reference);
 	}
diff --git a/vala/valaunaryexpression.vala b/vala/valaunaryexpression.vala
index 11c3bb417..ed308417f 100644
--- a/vala/valaunaryexpression.vala
+++ b/vala/valaunaryexpression.vala
@@ -51,7 +51,7 @@ public class Vala.UnaryExpression : Expression {
 	 * Creates a new unary expression.
 	 *
 	 * @param op     unary operator
-	 * @param inner  operand
+	 * @param _inner operand
 	 * @param source reference to source code
 	 * @return       newly created binary expression
 	 */
diff --git a/vala/valawhilestatement.vala b/vala/valawhilestatement.vala
index 267e35ed5..6a1bcde13 100644
--- a/vala/valawhilestatement.vala
+++ b/vala/valawhilestatement.vala
@@ -58,10 +58,10 @@ public class Vala.WhileStatement : CodeNode, Statement {
 	/**
 	 * Creates a new while statement.
 	 *
-	 * @param cond   loop condition
-	 * @param body   loop body
-	 * @param source reference to source code
-	 * @return       newly created while statement
+	 * @param condition         loop condition
+	 * @param body              loop body
+	 * @param source_reference  reference to source code
+	 * @return                  newly created while statement
 	 */
 	public WhileStatement (Expression condition, Block body, SourceReference? source_reference = null) {
 		this.body = body;