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

index 31fb3ee5723ce62fe1f58ad710cd5fade76ca54e..ca2ac1a3c10bffdbbbdee2aa2fde7e8f9eb48121 100644 (file)
 
 using Gee;
 
+
+/**
+ * Represents a runtime data type.
+ */
 public abstract class Valadoc.Api.TypeSymbol : Symbol {
 
        public TypeSymbol (Vala.TypeSymbol symbol, Node parent) {
                base (symbol, parent);
        }
 
+       /**
+        * Specifies whether this symbol is a basic type (string, int, char, etc)
+        */
        public bool is_basic_type {
                get {
                        if (symbol is Vala.Struct) {
@@ -41,6 +48,9 @@ public abstract class Valadoc.Api.TypeSymbol : Symbol {
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        internal override void process_comments (Settings settings, DocumentationParser parser) {
                var source_comment = ((Vala.TypeSymbol) symbol).comment;
                if (source_comment != null) {