libvaladoc: documentation fixes

diff --git a/src/libvaladoc/api/node.vala b/src/libvaladoc/api/node.vala
index ab440ba1488ec87bfbf1bfc625bb093c53b15f8a..e28a898792cc6b2147b01178fa9736476bc96a5d 100755 (executable)
--- 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 22a73aafc8d9217fbbd70ae2415c69294b5adaa9..158bd6e4191b52666a58ab0b5e73f40864265da1 100755 (executable)
--- 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 54f887d6f98812af8b0f58080d7e9c674d6ce0c0..9bd09ce6876e80c38b3dad90597bcae6c19bcc86 100755 (executable)
--- 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 863cc388516e32a4eaa71fc89860bfbff26ccf0f..b9c4d8cc1606baa5f57bcd9a407ed2a8eb6cb266 100755 (executable)
--- 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 137aff1cd8d30c2d19c8d32177e9836bc94d5384..7dcbec8af9520fd11155e3aa3e3d97ad0cbf7369 100755 (executable)
--- 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 ae0e56cc097064c1a687633b16e017192acfdd0d..28a61ffe72ad61d8eb7f8fd1e74b0e582403a336 100755 (executable)
--- 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) {