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

index 03d956a13aa904de39de2db303edf8a8d9532753..a03c440ca70ba2bf42fb5d18e4be448e42b8b0e5 100644 (file)
@@ -24,25 +24,43 @@ using Gee;
 using Valadoc.Content;
 
 
+/**
+ * Represents an error domain declaration.
+ */
 public class Valadoc.Api.ErrorDomain : TypeSymbol {
        public ErrorDomain (Vala.ErrorDomain symbol, Node parent) {
                base (symbol, parent);
        }
 
+       /**
+        * Returns the name of this errordomain as it is used in C.
+        */
        public string? get_cname () {
                return ((Vala.ErrorDomain) symbol).get_cname();
        }
 
+       /**
+        * Returns the dbus-name.
+        */
        public string? get_dbus_name () {
                return Vala.DBusModule.get_dbus_name ((Vala.TypeSymbol) symbol);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        public override NodeType node_type { get { return NodeType.ERROR_DOMAIN; } }
 
+       /**
+        * {@inheritDoc}
+        */
        public override void accept (Visitor visitor) {
                visitor.visit_error_domain (this);
        }
 
+       /**
+        * {@inheritDoc}
+        */
        protected override Inline build_signature () {
                return new SignatureBuilder ()
                        .append_keyword (get_accessibility_modifier ())