mcs/tools/monkeydoc/Monkeydoc/generator.cs

   1 using System;
   2
   3 namespace MonkeyDoc
   4 {
   5         // All type of documents that a generator may find as input
   6         public enum DocumentType {
   7                 EcmaXml, // Our main monodoc format
   8                 EcmaSpecXml,
   9                 Man,
  10                 AddinXml,
  11                 MonoBook, // This is mostly XHTML already, just need a tiny bit of processing
  12                 Html,
  13                 TocXml, // Used by help source displaying some kind of toc of the content they host
  14                 PlainText,
  15                 ErrorXml
  16         }
  17
  18         /* This interface defines a set of transformation engine
  19          * that convert multiple documentation source to a single output format
  20          */
  21         public interface IDocGenerator<TOutput>
  22         {
  23                 // This method is responsible for finding out the documentation type
  24                 // for the given ID and use the right engine internally
  25                 TOutput Generate (HelpSource hs, string internalId);
  26         }
  27 }