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

index bd4da7b766df7a6f1a1ef362876a1237614f784c..627d759c09886aadb0c4e091e15fba4477969203 100644 (file)
 using Valadoc.Content;
 using Gee;
 
+
+/**
+ * Represents a node in the api tree.
+ */
 public abstract class Valadoc.Api.Item : Object {
        private Inline _signature;
 
+       /**
+        * The parent of this item.
+        */
        public Item parent { protected set; get; }
 
        internal virtual void resolve_type_references (Tree root) {
@@ -37,6 +44,9 @@ public abstract class Valadoc.Api.Item : Object {
        internal virtual void process_comments (Settings settings, DocumentationParser parser) {
        }
 
+       /**
+        * The signature of this item.
+        */
        public Inline signature {
                get {
                        if (_signature == null) {