libvaladoc/doclet.vala

   1 /* doclet.vala
   2  *
   3  * Copyright (C) 2008-2009 Florian Brosch
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  18  *
  19  * Author:
  20  *      Brosch Florian <flo.brosch@gmail.com>
  21  */
  22
  23
  24 /**
  25  * A plugin register function for doclets
  26  *
  27  * @see ModuleLoader
  28  */
  29 [CCode (has_target = false)]
  30 public delegate Type Valadoc.DocletRegisterFunction (ModuleLoader module_loader);
  31
  32
  33
  34 /**
  35  * Provides a mechanism to inspect the API & documentation of programs and libraries
  36  */
  37 public interface Valadoc.Doclet : GLib.Object {
  38
  39         /**
  40          * Allows the doclet to inspect the given {@link Api.Tree}
  41          *
  42          * @param settings various configurations
  43          * @param tree the tree to inspect
  44          * @param reporter the reporter to use
  45          * @see Content.ContentVisitor
  46          * @see Api.Visitor
  47          */
  48         public abstract void process (Settings settings, Api.Tree tree, ErrorReporter reporter);
  49 }
  50
  51