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

index ee3038b443f92b7793a87e54717a559707918e3e..ef9dead992752aa32f2f9c53db761b13f4657e4f 100644 (file)
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents an enum member.
+ */
 public class Valadoc.Api.EnumValue: Symbol {
        public EnumValue (Vala.EnumValue symbol, Node parent) {
                base (symbol, parent);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_public {
                get {
                        return ((Enum)parent).is_public;
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_protected {
                get {
                        return ((Enum)parent).is_protected;
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_internal {
                get {
                        return ((Enum)parent).is_internal;
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_private {
                get {
                        return ((Enum)parent).is_private;
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        internal override void process_comments (Settings settings, DocumentationParser parser) {
                var source_comment = ((Vala.EnumValue) symbol).comment;
                if (source_comment != null) {
@@ -61,16 +80,28 @@ public class Valadoc.Api.EnumValue: Symbol {
                base.process_comments (settings, parser);
        }
 
+       /**
+        * Returns the name of this enum value as it is used in C.
+        */
        public string get_cname () {
                return ((Vala.EnumValue) symbol).get_cname ();
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override NodeType node_type { get { return NodeType.ENUM_VALUE; } }
 
+       /**
+        * {@inheritDoc}
+        */
        public override void accept (Visitor visitor) {
                visitor.visit_enum_value (this);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        protected override Inline build_signature () {
                var builder = new SignatureBuilder ()
                                .append_symbol (this);