[valadoc] libvaladoc: documentation fixes

[Florian Brosch <flobrosch src gnome org>]

commit df089746e63a6e8d7e5cb150c5da8926a778b5c6
Author: Florian Brosch <flo brosch gmail com>
Date:   Mon Mar 26 21:06:10 2012 +0200

    libvaladoc: documentation fixes

 src/libvaladoc/api/node.vala             |   11 +++++------
 src/libvaladoc/api/signaturebuilder.vala |   10 +++++-----
 src/libvaladoc/api/symbol.vala           |    3 +--
 src/libvaladoc/ctyperesolver.vala        |    2 +-
 src/libvaladoc/filehelper.vala           |    2 +-
 src/libvaladoc/markupwriter.vala         |   16 ++++++++--------
 6 files changed, 21 insertions(+), 23 deletions(-)
---
diff --git a/src/libvaladoc/api/node.vala b/src/libvaladoc/api/node.vala
index ab440ba..e28a898 100755
--- a/src/libvaladoc/api/node.vala
+++ b/src/libvaladoc/api/node.vala
@@ -169,10 +169,9 @@ public abstract class Valadoc.Api.Node : Item, Browsable, Documentation, Compara
 
 	/**
 	 * The corresponding file name
-	 *
-	 * @deprecated
 	 */
 	//TODO: rm
+	[Deprecated]
 	public string? get_filename () {
 		if (file == null) {
 			return null;
@@ -224,7 +223,7 @@ public abstract class Valadoc.Api.Node : Item, Browsable, Documentation, Compara
 	/**
 	 * Specifies whether this node has at least one child with the given types
 	 *
-	 * @param type a list of node types
+	 * @param types a list of node types
 	 */
 	public bool has_children (NodeType[] types) {
 		foreach (NodeType type in types) {
@@ -238,7 +237,7 @@ public abstract class Valadoc.Api.Node : Item, Browsable, Documentation, Compara
 	/**
 	 * Returns a list of all children with the given type.
 	 *
-	 * @param type a list of node types
+	 * @param type a node type
 	 * @param filtered specifies whether nodes which are not browsable should appear in the list
 	 */
 	public Gee.List<Node> get_children_by_type (NodeType type, bool filtered = true) {
@@ -259,7 +258,7 @@ public abstract class Valadoc.Api.Node : Item, Browsable, Documentation, Compara
 	/**
 	 * Returns a list of all children with the given types.
 	 *
-	 * @param type a list of node types
+	 * @param types a list of node types
 	 * @param filtered specifies whether nodes which are not browsable should appear in the list
 	 */
 	public Gee.List<Node> get_children_by_types (NodeType[] types, bool filtered = true) {
@@ -293,7 +292,7 @@ public abstract class Valadoc.Api.Node : Item, Browsable, Documentation, Compara
 	/**
 	 * Visits all children of this node with the given types with the specified Visitor.
 	 *
-	 * @param type a list of node types
+	 * @param types a list of node types
 	 * @param visitor the visitor to be called while traversing
 	 * @param filtered specifies whether nodes which are not browsable should appear in the list
 	 */
diff --git a/src/libvaladoc/api/signaturebuilder.vala b/src/libvaladoc/api/signaturebuilder.vala
index 22a73aa..158bd6e 100755
--- a/src/libvaladoc/api/signaturebuilder.vala
+++ b/src/libvaladoc/api/signaturebuilder.vala
@@ -48,7 +48,7 @@ public class Valadoc.Api.SignatureBuilder {
 	/**
 	 * Adds text onto the end of the builder. 
 	 *
-	 * @param literal a string
+	 * @param text a string
 	 * @param spaced add a space at the front of the string if necessary
 	 * @return this
 	 */
@@ -61,7 +61,7 @@ public class Valadoc.Api.SignatureBuilder {
 	/**
 	 * Adds text onto the end of the builder. 
 	 *
-	 * @param literal a string
+	 * @param text a string
 	 * @param spaced add a space at the front of the string if necessary
 	 * @return this
 	 */
@@ -74,7 +74,7 @@ public class Valadoc.Api.SignatureBuilder {
 	/**
 	 * Adds highlighted text onto the end of the builder. 
 	 *
-	 * @param literal a string
+	 * @param text a string
 	 * @param spaced add a space at the front of the string if necessary
 	 * @return this
 	 */
@@ -88,7 +88,7 @@ public class Valadoc.Api.SignatureBuilder {
 	/**
 	 * Adds a Inline onto the end of the builder. 
 	 *
-	 * @param literal a content
+	 * @param content a content
 	 * @param spaced add a space at the front of the inline if necessary
 	 * @return this
 	 */
@@ -103,7 +103,7 @@ public class Valadoc.Api.SignatureBuilder {
 	/**
 	 * Adds a keyword onto the end of the builder. 
 	 *
-	 * @param literal a keyword
+	 * @param keyword a keyword
 	 * @param spaced add a space at the front of the keyword if necessary
 	 * @return this
 	 */
diff --git a/src/libvaladoc/api/symbol.vala b/src/libvaladoc/api/symbol.vala
index 54f887d..9bd09ce 100755
--- a/src/libvaladoc/api/symbol.vala
+++ b/src/libvaladoc/api/symbol.vala
@@ -137,10 +137,9 @@ public abstract class Valadoc.Api.Symbol : Node {
 
 	/**
 	 * Returns the accessibility modifier as string
-	 *
-	 * @deprecated
 	 */
 	//TODO: rm
+	[Deprecated]
 	protected string get_accessibility_modifier () {
 		return accessibility.to_string ();
 	}
diff --git a/src/libvaladoc/ctyperesolver.vala b/src/libvaladoc/ctyperesolver.vala
index 863cc38..b9c4d8c 100755
--- a/src/libvaladoc/ctyperesolver.vala
+++ b/src/libvaladoc/ctyperesolver.vala
@@ -116,7 +116,7 @@ public class Valadoc.CTypeResolver : Visitor {
 	/**
 	 * Resolves symbols by C-names
 	 *
-	 * @param name a C-name
+	 * @param _name a C-name
 	 * @return the resolved node or null
 	 */
 	public Api.Node? resolve_symbol (Api.Node? element, string _name) {
diff --git a/src/libvaladoc/filehelper.vala b/src/libvaladoc/filehelper.vala
index 137aff1..7dcbec8 100755
--- a/src/libvaladoc/filehelper.vala
+++ b/src/libvaladoc/filehelper.vala
@@ -117,7 +117,7 @@ namespace Valadoc {
 	/**
 	 * Returns canonicalized absolute pathname
 	 *
-	 * @param basedir the path being checked
+	 * @param name the path being checked
 	 * @return a canonicalized absolute pathname
 	 */
 	public string realpath (string name) {
diff --git a/src/libvaladoc/markupwriter.vala b/src/libvaladoc/markupwriter.vala
index ae0e56c..28a61ff 100755
--- a/src/libvaladoc/markupwriter.vala
+++ b/src/libvaladoc/markupwriter.vala
@@ -81,7 +81,7 @@ public class Valadoc.MarkupWriter {
 	}
 
 	/**
-	 * Writes text to a desination like a { link StringBuilder} or a { link FileStream}
+	 * Writes text to a desination like a { link GLib.StringBuilder} or a { link GLib.FileStream}
 	 */
 	public delegate void WriteFunc (string text);
 
@@ -90,8 +90,8 @@ public class Valadoc.MarkupWriter {
 	/**
 	 * Initializes a new instance of the MarkupWriter
 	 * 
-	 * @param stream a WriteFunc
-	 * @param xml_delcaration specifies whether this file starts with an xml-declaration
+	 * @param write stream a WriteFunc
+	 * @param xml_declaration specifies whether this file starts with an xml-declaration
 	 */
 	public MarkupWriter (owned WriteFunc write, bool xml_declaration = true) {
 		this.write = (owned) write;
@@ -105,8 +105,8 @@ public class Valadoc.MarkupWriter {
 	/**
 	 * Writes an start tag of a markup element to the file
 	 *
-	 * @param the name of the markup
-	 * @param a list of name/value pairs
+	 * @param name the name of the markup
+	 * @param attributes a list of name/value pairs
 	 * @return this
 	 */
 	public MarkupWriter start_tag (string name, string[]? attributes=null) {
@@ -135,8 +135,8 @@ public class Valadoc.MarkupWriter {
 	/**
 	 * Writes a simple tag (<name />) to the file
 	 *
-	 * @param the name of the markup
-	 * @param a list of name/value pairs
+	 * @param name the name of the markup
+	 * @param attributes a list of name/value pairs
 	 * @return this
 	 */
 	public MarkupWriter simple_tag (string name, string[]? attributes=null) {
@@ -166,7 +166,7 @@ public class Valadoc.MarkupWriter {
 	/**
 	 * Writes an end tag of a markup element to the file
 	 *
-	 * @param the name of the markup
+	 * @param name the name of the markup
 	 * @return this
 	 */
 	public MarkupWriter end_tag (string name) {