[valadoc] libvaladoc/api: Add API documentation for Errorcode
- From: Florian Brosch <flobrosch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [valadoc] libvaladoc/api: Add API documentation for Errorcode
- Date: Mon, 28 Feb 2011 14:16:11 +0000 (UTC)
commit 482c543b03eeba5b10d5a4b3f032ac64d0a8f1db
Author: Florian Brosch <flo brosch gmail com>
Date: Mon Feb 28 01:51:29 2011 +0100
libvaladoc/api: Add API documentation for Errorcode
src/libvaladoc/api/errorcode.vala | 31 +++++++++++++++++++++++++++++++
1 files changed, 31 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/errorcode.vala b/src/libvaladoc/api/errorcode.vala
index ded2078..f72d212 100644
--- a/src/libvaladoc/api/errorcode.vala
+++ b/src/libvaladoc/api/errorcode.vala
@@ -23,49 +23,80 @@
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)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]