[valadoc] libvaladoc/api: Add API documentation for Package
- From: Florian Brosch <flobrosch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [valadoc] libvaladoc/api: Add API documentation for Package
- Date: Mon, 28 Feb 2011 14:16:36 +0000 (UTC)
commit dea38ec067a02e19287182d084169c8c7db490df
Author: Florian Brosch <flo brosch gmail com>
Date: Mon Feb 28 01:53:04 2011 +0100
libvaladoc/api: Add API documentation for Package
src/libvaladoc/api/package.vala | 22 ++++++++++++++++++++++
1 files changed, 22 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/api/package.vala b/src/libvaladoc/api/package.vala
index 031ad40..8d2c62e 100644
--- a/src/libvaladoc/api/package.vala
+++ b/src/libvaladoc/api/package.vala
@@ -31,6 +31,9 @@ public class Valadoc.Api.Package : Node {
this.vfiles.add (vfile);
}
+ /**
+ * Specifies whether this package is a dependency
+ */
public bool is_package {
private set;
get;
@@ -42,6 +45,9 @@ public class Valadoc.Api.Package : Node {
private ArrayList<Package> _dependencies;
+ /**
+ * Returns a list with all dependencies
+ */
public Collection<Package> get_full_dependency_list () {
ArrayList<Package> list = new ArrayList<Package> ();
@@ -64,6 +70,7 @@ public class Valadoc.Api.Package : Node {
return list.read_only_view;
}
+ //TODO: rm
public Collection<Package> get_dependency_list () {
if (this._dependencies == null) {
return Collection.empty<Package> ();
@@ -84,6 +91,9 @@ public class Valadoc.Api.Package : Node {
private string package_name;
+ /**
+ * { inheritDoc}
+ */
public override string? name {
owned get {
return package_name;
@@ -94,16 +104,28 @@ public class Valadoc.Api.Package : Node {
return this.vfiles.contains (source_file);
}
+ /**
+ * { inheritDoc}
+ */
public override bool is_browsable (Settings settings) {
return !(this.is_package && settings.with_deps == false);
}
+ /**
+ * { inheritDoc}
+ */
public override NodeType node_type { get { return NodeType.PACKAGE; } }
+ /**
+ * { inheritDoc}
+ */
public override void accept (Visitor visitor) {
visitor.visit_package (this);
}
+ /**
+ * { inheritDoc}
+ */
protected override Inline build_signature () {
return new SignatureBuilder ()
.append_keyword ("package")
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]