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

index ded2078f735fd5ad0744e08f7b74ee39a809ee97..f72d2127d16b8a8caa2c6d185f230a5b5b1b397c 100644 (file)
 using Gee;
 using Valadoc.Content;
 
+
+/**
+ * Represents an errordomain member in the source code.
+ */
 public class Valadoc.Api.ErrorCode : TypeSymbol {
        public ErrorCode (Vala.ErrorCode symbol, Node parent) {
                base (symbol, parent);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_public {
                get {
                        return ((ErrorDomain)parent).is_public;
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_protected {
                get {
                        return ((ErrorDomain)parent).is_protected;
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_internal {
                get {
                        return ((ErrorDomain)parent).is_internal;
                }
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override bool is_private {
                get {
                        return ((ErrorDomain)parent).is_private;
                }
        }
 
+       /**
+        * Returns the name of this class as it is used in C.
+        */
        public string get_cname () {
                return ((Vala.ErrorCode) symbol).get_cname ();
        }
 
+       /**
+        * Returns the dbus-name.
+        */
        public string get_dbus_name () {
                return Vala.DBusModule.get_dbus_name_for_member (symbol);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override NodeType node_type { get { return NodeType.ERROR_CODE; } }
 
+       /**
+        * {@inheritDoc}
+        */
        public override void accept (Visitor visitor) {
                visitor.visit_error_code (this);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        protected override Inline build_signature () {
                return new SignatureBuilder ()
                        .append_symbol (this)