Make NDoc compile the code examples contained in your documentation using NLiterate

// The MIT License
// Copyright (c) 2004 Jonathan de Halleux
//
// Permission is hereby granted, free of charge, to any person obtaining a 
// copy of this software and associated documentation files (the "Software"), 
// to deal in the Software without restriction, including without limitation 
// the rights to use, copy, modify, merge, publish, distribute, sublicense, 
// and/or sell copies of the Software, and to permit persons to whom the 
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in 
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.

namespace NLiterate
{
	using System;
	using System.IO;
	using System.Xml;
	using System.Diagnostics;
	using System.Text.RegularExpressions;	
	using System.Reflection;
	using NDoc.Core;
	
	/// <summary>
	/// NDoc <see cref="IDocumenter"/> that applies literate programming
	/// to comments.
	/// </summary>
	/// <remarks>
	/// </remarks>
	public class LiterateDocumenter : BaseDocumenter
	{	
		#region Private Fields
		private CodeSnippetCollection snippets;
		#endregion 
		
		/// <summary>
		/// Initializes a new instance of the class.
		/// </summary>
		public LiterateDocumenter()
		:base("Literate")
		{
			this.Clear();
		}
		
		#region IDocumenter
		/// <summary>
		/// Builds the documentation.
		/// </summary>
		public override void Build(Project project)
		{
			// step one, load snippets
			loadSnippets(project);
			// step two, compile the snippets
			compileSnippets(project);
			// step three, create the report
			compileReport(project);
			//
		}
		
		/// <summary>
		/// Resets the documenter to a clean state.
		/// </summary>
		public override void Clear()
		{
			this.Config=new LiterateDocumenterConfig();
			this.snippets=new CodeSnippetCollection();
		}

		/// <summary>
		/// Gets the development status (alpha, beta, stable) of this documenter.  
		/// </summary>
		/// <value>
		/// The development status (alpha, beta, stable) of this documenter. 
		/// </value>		
		public override DocumenterDevelopmentStatus DevelopmentStatus 
		{ 
			get
			{
				return DocumenterDevelopmentStatus.Alpha;
			}
		}
		
		/// <summary>
		/// Gets the documenter's main output file path. 
		/// </summary>
		/// <value>
		/// The Documenter's main output file path
		/// </value>
		public override string MainOutputFile
		{
			get
			{
				return ((LiterateDocumenterConfig)this.Config).OutputFile;
			}
		}
		#endregion

		#region Private implementation
		// step one, load the snippets
		private void loadSnippets(Project project)
		{
			foreach(AssemblySlashDoc ad in project.GetAssemblySlashDocs())
			{
				Assembly a  = BaseDocumenter.LoadAssembly(ad.AssemblyFilename );
				XmlDocument doc = new XmlDocument();
				doc.Load( ad.SlashDocFilename);
				
				CodeSnippet.FromXml(a.Location, doc, snippets);
			}			
		}
		
		private void compileSnippets(Project project)
		{
			CodeSnippetCompiler compiler = new CodeSnippetCompiler();
			compiler.BeginCompile+=new CodeSnippetEventHandler(compiler_BeginCompile);
			compiler.BeginRun+=new CodeSnippetEventHandler(compiler_BeginRun);
			compiler.CompileFailure+=new CodeSnippetEventHandler(compiler_CompileFailure);
			compiler.CompileSuccess+=new CodeSnippetEventHandler(compiler_CompileSuccess);
			
			foreach(CodeSnippet snippet in this.snippets)
			{
				compiler.Process(snippet);
			}			
		}
		
		
		// step three, create the report
		private void compileReport(Project project)
		{
			String path = Path.GetDirectoryName(this.MainOutputFile);
			if (path!=null && path.Length!=0)
			{
				if (!Directory.Exists(path))
					Directory.CreateDirectory(path);
			}

			using(StreamWriter writer = new StreamWriter(File.Open(this.MainOutputFile,FileMode.Create)))
			{
				foreach(CodeSnippet snippet in this.snippets)
				{
					writer.WriteLine(snippet.ToString());
				}
			}
		}

		private void compiler_BeginCompile(Object sender, CodeSnippetEventArgs e)
		{
		}

		private void compiler_BeginRun(Object sender, CodeSnippetEventArgs e)
		{

		}

		private void compiler_CompileFailure(Object sender, CodeSnippetEventArgs e)
		{

		}

		private void compiler_CompileSuccess(Object sender, CodeSnippetEventArgs e)
		{

		}
		#endregion
	}
}