From: Florian Brosch <flo.brosch@gmail.com>
Date: Mon, 28 Feb 2011 00:51:29 +0000 (+0100)
Subject: libvaladoc/api: Add API documentation for Errorcode
X-Git-Tag: 0.37.1~3^2~349
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=482c543b03eeba5b10d5a4b3f032ac64d0a8f1db;p=thirdparty%2Fvala.git

libvaladoc/api: Add API documentation for Errorcode
---

diff --git a/src/libvaladoc/api/errorcode.vala b/src/libvaladoc/api/errorcode.vala
index ded2078f7..f72d2127d 100644
--- a/src/libvaladoc/api/errorcode.vala
+++ b/src/libvaladoc/api/errorcode.vala
@@ -23,49 +23,80 @@
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents an errordomain member in the source code.
+ */
 public class Valadoc.Api.ErrorCode : TypeSymbol {
 	public ErrorCode (Vala.ErrorCode symbol, Node parent) {
 		base (symbol, parent);
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override bool is_public {
 		get {
 			return ((ErrorDomain)parent).is_public;
 		}
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override bool is_protected {
 		get {
 			return ((ErrorDomain)parent).is_protected;
 		}
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override bool is_internal {
 		get {
 			return ((ErrorDomain)parent).is_internal;
 		}
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override bool is_private {
 		get {
 			return ((ErrorDomain)parent).is_private;
 		}
 	}
 
+	/**
+	 * Returns the name of this class as it is used in C.
+	 */
 	public string get_cname () {
 		return ((Vala.ErrorCode) symbol).get_cname ();
 	}
 
+	/**
+	 * Returns the dbus-name.
+	 */
 	public string get_dbus_name () {
 		return Vala.DBusModule.get_dbus_name_for_member (symbol);
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override NodeType node_type { get { return NodeType.ERROR_CODE; } }
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override void accept (Visitor visitor) {
 		visitor.visit_error_code (this);
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	protected override Inline build_signature () {
 		return new SignatureBuilder ()
 			.append_symbol (this)