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

index 5a19982c459b7606915fa8097758372f71700d71..d4b59f46c27bc9d89d7778a59e64a8d202706407 100644 (file)
 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 ())