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