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

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

diff --git a/src/libvaladoc/api/propertyaccessor.vala b/src/libvaladoc/api/propertyaccessor.vala
index 593068a2c..3bdb9408e 100644
--- a/src/libvaladoc/api/propertyaccessor.vala
+++ b/src/libvaladoc/api/propertyaccessor.vala
@@ -23,6 +23,10 @@
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents a get or set accessor of a property.
+ */
 public class Valadoc.Api.PropertyAccessor : Symbol {
 	private Vala.PropertyAccessor vpropacc;
 
@@ -31,39 +35,63 @@ public class Valadoc.Api.PropertyAccessor : Symbol {
 		this.vpropacc = symbol;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override NodeType node_type { get { return NodeType.PROPERTY_ACCESSOR; } }
 
+	/**
+	 * Returns the name of this property accessor as it is used in C.
+	 */
 	public string? get_cname () {
 		return vpropacc.get_cname ();
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override void accept (Visitor visitor) {
 	}
 
+	/**
+	 * Specifies whether this accessor may be used to construct the property.
+	 */
 	public bool is_construct {
 		get {
 			return this.vpropacc.construction;
 		}
 	}
 
+	/**
+	 * Specifies whether this accessor is a setter.
+	 */
 	public bool is_set {
 		get {
 			return this.vpropacc.writable;
 		}
 	}
 
+	/**
+	 * Specifies whether this accessor is a getter.
+	 */
 	public bool is_get {
 		get {
 			return this.vpropacc.readable;
 		}
 	}
 
+	/**
+	 * Specifies whether the property is owned.
+	 */
 	public bool is_owned {
 		get {
 			return this.vpropacc.value_type.value_owned;
 		}
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	protected override Inline build_signature () {
 		var signature = new SignatureBuilder ();