[valadoc] libvaladoc/api: Add API documentation for Signal

[Florian Brosch <flobrosch src gnome org>]

commit a20b9c99bce0b790bdf3f05b4111b1cf23a900e4
Author: Florian Brosch <flo brosch gmail com>
Date:   Mon Feb 28 01:52:24 2011 +0100

    libvaladoc/api: Add API documentation for Signal

 src/libvaladoc/api/signal.vala |   33 +++++++++++++++++++++++++++++++++
 1 files changed, 33 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/signal.vala b/src/libvaladoc/api/signal.vala
index ffecf94..ed16ba8 100644
--- a/src/libvaladoc/api/signal.vala
+++ b/src/libvaladoc/api/signal.vala
@@ -23,40 +23,67 @@
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents an signal.
+ */
 public class Valadoc.Api.Signal : Member {
 	public Signal (Vala.Signal symbol, Node parent) {
 		base (symbol, parent);
 		return_type = new TypeReference (symbol.return_type, this);
 	}
 
+	/**
+	 * Returns the name of this signal as it is used in C.
+	 */
 	public string? get_cname () {
 		return ((Vala.Signal) symbol).get_cname();
 	}
 
+	/**
+	 * Returns the dbus-name.
+	 */
 	public string get_dbus_name () {
 		return Vala.DBusModule.get_dbus_name_for_member (symbol);
 	}
 
+	/**
+	 * The return type of this signal.
+	 *
+	 * @return The return type of this signal or null for void
+	 */
 	public TypeReference? return_type { protected set; get; }
 
+	/**
+	 * { inheritDoc}
+	 */
 	internal override void resolve_type_references (Tree root) {
 		return_type.resolve_type_references (root);
 
 		base.resolve_type_references (root);
 	}
 
+	/**
+	 * Specifies whether this signal is virtual
+	 */
 	public bool is_virtual {
 		get {
 			return ((Vala.Signal) symbol).is_virtual;
 		}
 	}
 
+	/**
+	 * Specifies whether this signal is visible for dbus
+	 */
 	public bool is_dbus_visible {
 		get {
 			return Vala.DBusServerModule.is_dbus_visible (symbol);
 		}
 	}
 
+	/**
+	 * { inheritDoc}
+	 */
 	protected override Inline build_signature () {
 		var signature = new SignatureBuilder ();
 
@@ -83,8 +110,14 @@ public class Valadoc.Api.Signal : Member {
 		return signature.get ();
 	}
 
+	/**
+	 * { inheritDoc}
+	 */
 	public override NodeType node_type { get { return NodeType.SIGNAL; } }
 
+	/**
+	 * { inheritDoc}
+	 */
 	public override void accept (Visitor visitor) {
 		visitor.visit_signal (this);
 	}