[valadoc] libvaladoc: Add API documentation for Doclet

[Florian Brosch <flobrosch src gnome org>]

commit 97d84d4893f7512239dfa018f9450b41f29243da
Author: Florian Brosch <flo brosch gmail com>
Date:   Mon Feb 28 11:08:09 2011 +0100

    libvaladoc: Add API documentation for Doclet

 src/libvaladoc/doclet.vala |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)
---
diff --git a/src/libvaladoc/doclet.vala b/src/libvaladoc/doclet.vala
index c98adcf..83abba2 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);
 }
+
+