]> git.ipfire.org Git - thirdparty/vala.git/commitdiff
libvaladoc/api: Add API documentation for Struct
authorFlorian Brosch <flo.brosch@gmail.com>
Mon, 28 Feb 2011 11:17:39 +0000 (12:17 +0100)
committerFlorian Brosch <flo.brosch@gmail.com>
Mon, 28 Feb 2011 11:53:36 +0000 (12:53 +0100)
src/libvaladoc/api/struct.vala

index 0e01c17e17a857df7e6527d417203ebfc5f4d649..9df0a6f5752ed6535fe85e6cc8e4cb8cf095ddb3 100644 (file)
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents a struct declaration.
+ */
 public class Valadoc.Api.Struct : TypeSymbol {
        public Struct (Vala.Struct symbol, Node parent) {
                base (symbol, parent);
        }
 
+       /**
+        * Specifies the base struct.
+        */
        public TypeReference? base_type { private set; get; }
 
+
+       /**
+        * Returns the name of this struct as it is used in C.
+        */
        public string? get_cname () {
                return ((Vala.Struct) symbol).get_cname();
        }
 
+       /**
+        * Returns the C function name that duplicates instances of this data
+        * type.
+        */
        public string? get_dup_function_cname () {
                return ((Vala.Struct) symbol).get_dup_function ();
        }
 
+       /**
+        * Returns the C function name that frees instances of this data type.
+        */
        public string? get_free_function_cname () {
                return ((Vala.Struct) symbol).get_free_function ();
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override NodeType node_type { get { return NodeType.STRUCT; } }
 
+       /**
+        * {@inheritDoc}
+        */
        public override void accept (Visitor visitor) {
                visitor.visit_struct (this);
        }
@@ -57,12 +81,18 @@ public class Valadoc.Api.Struct : TypeSymbol {
                this.base_type.resolve_type_references (root);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        internal override void resolve_type_references (Tree root) {
                this.set_parent_references (root);
 
                base.resolve_type_references (root);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        protected override Inline build_signature () {
                var signature = new SignatureBuilder ();