libvaladoc: Add API documentation for Doclet

diff --git a/src/libvaladoc/doclet.vala b/src/libvaladoc/doclet.vala
index c98adcf4978e12bba0a7ea3c4388c8a2cd0f45af..83abba2ffe9a3d1a0d00c2c7051ca1215fa076ec 100755 (executable)
--- 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);
 }
+
+