[valadoc] libvaladoc/api: Add API documentation for TypeSymbol



commit cd82af2849eff711d6faba2b225ed772cf2eed5f
Author: Florian Brosch <flo brosch gmail com>
Date:   Mon Feb 28 01:48:40 2011 +0100

    libvaladoc/api: Add API documentation for TypeSymbol

 src/libvaladoc/api/typesymbol.vala |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/typesymbol.vala b/src/libvaladoc/api/typesymbol.vala
index 31fb3ee..ca2ac1a 100644
--- a/src/libvaladoc/api/typesymbol.vala
+++ b/src/libvaladoc/api/typesymbol.vala
@@ -22,12 +22,19 @@
 
 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) {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]