From: Florian Brosch <flo.brosch@gmail.com>
Date: Mon, 28 Feb 2011 00:46:53 +0000 (+0100)
Subject: libvaladoc/api: Add API documentation for Enum
X-Git-Tag: 0.37.1~3^2~361
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d37688560fbf3cc687a531a2b5152c856a1be333;p=thirdparty%2Fvala.git

libvaladoc/api: Add API documentation for Enum
---

diff --git a/src/libvaladoc/api/enum.vala b/src/libvaladoc/api/enum.vala
index 5a19982c4..d4b59f46c 100644
--- a/src/libvaladoc/api/enum.vala
+++ b/src/libvaladoc/api/enum.vala
@@ -23,21 +23,37 @@
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents an enum declaration.
+ */
 public class Valadoc.Api.Enum : TypeSymbol {
 	public Enum (Vala.Enum symbol, Node parent) {
 		base (symbol, parent);
 	}
 
+	/**
+	 * Returns the name of this enum as it is used in C.
+	 */
 	public string? get_cname () {
 		return ((Vala.Enum) symbol).get_cname ();
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override NodeType node_type { get { return NodeType.ENUM; } }
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public override void accept (Visitor visitor) {
 		visitor.visit_enum (this);
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	protected override Inline build_signature () {
 		return new SignatureBuilder ()
 			.append_keyword (get_accessibility_modifier ())