From: Florian Brosch <flo.brosch@gmail.com>
Date: Mon, 28 Feb 2011 10:08:09 +0000 (+0100)
Subject: libvaladoc: Add API documentation for Doclet
X-Git-Tag: 0.37.1~3^2~337
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=97d84d4893f7512239dfa018f9450b41f29243da;p=thirdparty%2Fvala.git

libvaladoc: Add API documentation for Doclet
---

diff --git a/src/libvaladoc/doclet.vala b/src/libvaladoc/doclet.vala
index c98adcf49..83abba2ff 100755
--- a/src/libvaladoc/doclet.vala
+++ b/src/libvaladoc/doclet.vala
@@ -22,9 +22,31 @@
 
 using Gee;
 
+/**
+ * A plugin register function for doclets
+ *
+ * @see ModuleLoader
+ */
 [CCode (has_target = false)]
 public delegate Type Valadoc.DocletRegisterFunction (GLib.TypeModule module);
 
+
+
+/**
+ * Provides a mechanism to inspect the API & documentation of programs and libraries
+ */
 public interface Valadoc.Doclet : GLib.Object {
+
+	/**
+	 * Allows the doclet to inspect the given {@link Api.Tree}
+	 *
+	 * @param settings various configurations
+	 * @param tree the tree to inspect
+	 * @param reporter the reporter to use
+	 * @see Content.ContentVisitor
+	 * @see Api.Visitor
+	 */
 	public abstract void process (Settings settings, Api.Tree tree, ErrorReporter reporter);
 }
+
+