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



commit ab52a8ef5ab6da8839320dee7b1a0df15ebb3105
Author: Florian Brosch <flo brosch gmail com>
Date:   Sun Feb 27 20:25:21 2011 +0100

    libvaladoc/api: Add API documentation for Delegate

 src/libvaladoc/api/delegate.vala |   27 +++++++++++++++++++++++++++
 1 files changed, 27 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/delegate.vala b/src/libvaladoc/api/delegate.vala
index 8f074fe..cfd4fe2 100644
--- a/src/libvaladoc/api/delegate.vala
+++ b/src/libvaladoc/api/delegate.vala
@@ -23,36 +23,63 @@
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents a Delegate.
+ */
 public class Valadoc.Api.Delegate : TypeSymbol {
 	public Delegate (Vala.Delegate symbol, Node parent) {
 		base (symbol, parent);
 		return_type = new TypeReference (symbol.return_type, this);
 	}
 
+	/**
+	 * Returns the name of this delegate as it is used in C.
+	 */
 	public string? get_cname () {
 		return ((Vala.Delegate) symbol).get_cname ();
 	}
 
+	/**
+	 * The return type of this callback.
+	 *
+	 * @return The return type of this callback or null for void
+	 */
 	public TypeReference? return_type { private set; get; }
 
+	/**
+	 * { inheritDoc}
+	 */
 	public override NodeType node_type { get { return NodeType.DELEGATE; } }
 
+	/**
+	 * { inheritDoc}
+	 */
 	public override void accept (Visitor visitor) {
 		visitor.visit_delegate (this);
 	}
 
+	/**
+	 * Specifies whether this delegate is static
+	 */
 	public bool is_static {
 		get {
 			return !((Vala.Delegate) symbol).has_target;
 		}
 	}
 
+	/**
+	 * { inheritDoc}
+	 */
 	internal override void resolve_type_references (Tree root) {
 		return_type.resolve_type_references (root);
 
 		base.resolve_type_references (root);
 	}
 
+	/**
+	 * { inheritDoc}
+	 */
 	protected override Inline build_signature () {
 		var signature = new SignatureBuilder ();
 



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