[valadoc] libvaladoc/api: Add API documentation for Enum
- From: Florian Brosch <flobrosch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [valadoc] libvaladoc/api: Add API documentation for Enum
- Date: Mon, 28 Feb 2011 14:15:11 +0000 (UTC)
commit d37688560fbf3cc687a531a2b5152c856a1be333
Author: Florian Brosch <flo brosch gmail com>
Date: Mon Feb 28 01:46:53 2011 +0100
libvaladoc/api: Add API documentation for Enum
src/libvaladoc/api/enum.vala | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/enum.vala b/src/libvaladoc/api/enum.vala
index 5a19982..d4b59f4 100644
--- a/src/libvaladoc/api/enum.vala
+++ b/src/libvaladoc/api/enum.vala
@@ -23,21 +23,37 @@
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 ())
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]