]> git.ipfire.org Git - thirdparty/vala.git/commitdiff
libvaladoc/api: Add API documentation for PropertyAccessor
authorFlorian Brosch <flo.brosch@gmail.com>
Mon, 28 Feb 2011 00:51:59 +0000 (01:51 +0100)
committerFlorian Brosch <flo.brosch@gmail.com>
Mon, 28 Feb 2011 00:51:59 +0000 (01:51 +0100)
src/libvaladoc/api/propertyaccessor.vala

index 593068a2c85f285a9aac3ba9cd26dfbd95ba928e..3bdb9408eb0d0f3652c875af79301e403c897016 100644 (file)
 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 ();