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



commit f4b3c0da175eda735cace0cfe08740eecae73e3d
Author: Florian Brosch <flo brosch gmail com>
Date:   Mon Feb 28 01:51:14 2011 +0100

    libvaladoc/api: Add API documentation for Errordomain

 src/libvaladoc/api/errordomain.vala |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/errordomain.vala b/src/libvaladoc/api/errordomain.vala
index 03d956a..a03c440 100644
--- a/src/libvaladoc/api/errordomain.vala
+++ b/src/libvaladoc/api/errordomain.vala
@@ -24,25 +24,43 @@ using Gee;
 using Valadoc.Content;
 
 
+/**
+ * Represents an error domain declaration.
+ */
 public class Valadoc.Api.ErrorDomain : TypeSymbol {
 	public ErrorDomain (Vala.ErrorDomain symbol, Node parent) {
 		base (symbol, parent);
 	}
 
+	/**
+	 * Returns the name of this errordomain as it is used in C.
+	 */
 	public string? get_cname () {
 		return ((Vala.ErrorDomain) symbol).get_cname();
 	}
 
+	/**
+	 * Returns the dbus-name.
+	 */
 	public string? get_dbus_name () {
 		return Vala.DBusModule.get_dbus_name ((Vala.TypeSymbol) symbol);
 	}
 
+	/**
+	 * { inheritDoc}
+	 */
 	public override NodeType node_type { get { return NodeType.ERROR_DOMAIN; } }
 
+	/**
+	 * { inheritDoc}
+	 */
 	public override void accept (Visitor visitor) {
 		visitor.visit_error_domain (this);
 	}
 
+	/**
+	 * { inheritDoc}
+	 */
 	protected override Inline build_signature () {
 		return new SignatureBuilder ()
 			.append_keyword (get_accessibility_modifier ())



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