[valadoc] libvaladoc/api: Add API documentation for Item
- From: Florian Brosch <flobrosch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [valadoc] libvaladoc/api: Add API documentation for Item
- Date: Mon, 28 Feb 2011 14:15:26 +0000 (UTC)
commit 89900d4f77d633959bb5209b0829e31caccbfd5e
Author: Florian Brosch <flo brosch gmail com>
Date: Mon Feb 28 01:48:00 2011 +0100
libvaladoc/api: Add API documentation for Item
src/libvaladoc/api/item.vala | 10 ++++++++++
1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/item.vala b/src/libvaladoc/api/item.vala
index bd4da7b..627d759 100644
--- a/src/libvaladoc/api/item.vala
+++ b/src/libvaladoc/api/item.vala
@@ -23,9 +23,16 @@
using Valadoc.Content;
using Gee;
+
+/**
+ * Represents a node in the api tree.
+ */
public abstract class Valadoc.Api.Item : Object {
private Inline _signature;
+ /**
+ * The parent of this item.
+ */
public Item parent { protected set; get; }
internal virtual void resolve_type_references (Tree root) {
@@ -37,6 +44,9 @@ public abstract class Valadoc.Api.Item : Object {
internal virtual void process_comments (Settings settings, DocumentationParser parser) {
}
+ /**
+ * The signature of this item.
+ */
public Inline signature {
get {
if (_signature == null) {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]