Permalink
Browse files

Added sandcastle documentation engine (merge from sandcastle branch).

  • Loading branch information...
1 parent 45aed7e commit 02d5eb1f19e24798091791e869369b2a1cb01d39 @AArnott AArnott committed May 25, 2008
Showing 443 changed files with 40,425 additions and 0 deletions.
View
@@ -1,4 +1,5 @@
bin
+obj
TestResult.xml
*.VisualState.xml
Drop
View
@@ -0,0 +1,2 @@
+api
+*.chm
@@ -0,0 +1,44 @@
+<!--
+ To build the documentation, use the following command:
+ msbuild example.proj
+
+ By default, this script builds the output using the 'prototype' look-and-feel. You
+ can choose a different output style by adding one of the following options to the
+ command line:
+ /property:PresentationStyle=vs2005
+ /property:PresentationStyle=hana
+ /property:PresentationStyle=prototype
+
+ The default target is "Chm", which builds a CHM file for the DotNetOpenId assembly. You can
+ also specify one of the following targets on the command line:
+ /target:Clean - removes all generated files
+ /target:HxS - builds HxS file for Visual Studio in addition to CHM
+
+ NOTE: To build an HxS you must have the "Microsoft Help 2.0 SDK" installed.
+ -->
+
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+ <PropertyGroup>
+ <NetfxVer>2.0</NetfxVer>
+ <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+ <ProjectRoot>..\..</ProjectRoot>
+ <OutputAssembly>DotNetOpenId</OutputAssembly>
+ <OutputPath>$(ProjectRoot)\bin\$(Configuration)</OutputPath>
+ <DocOutputPath>$(ProjectRoot)\doc</DocOutputPath>
+ <IntermediatePath>$(ProjectRoot)\obj\$(Configuration)</IntermediatePath>
+ <DocumentationFile>$(OutputPath)\$(OutputAssembly).xml</DocumentationFile>
+ </PropertyGroup>
+
+ <Target Name="Build" DependsOnTargets="Compile;Chm" />
+
+ <Target Name="Compile">
+ <MSBuild Projects="..\DotNetOpenId\DotNetOpenId.csproj" />
+ </Target>
+
+ <Target Name="CompileCustomBuildTasks">
+ <MSBuild Projects="..\DotNetOpenId.BuildTasks\DotNetOpenId.BuildTasks.csproj" />
+ </Target>
+
+ <Import Project="..\..\Tools\Sandcastle\sandcastle.targets" />
+
+</Project>
@@ -0,0 +1,20 @@
+
+Microsoft Visual Studio Solution File, Format Version 10.00
+# Visual Studio 2008
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DotNetOpenId.BuildTasks", "DotNetOpenId.BuildTasks.csproj", "{AC231A51-EF60-437C-A33F-AF8ADEB8EB74}"
+EndProject
+Global
+ GlobalSection(SolutionConfigurationPlatforms) = preSolution
+ Debug|Any CPU = Debug|Any CPU
+ Release|Any CPU = Release|Any CPU
+ EndGlobalSection
+ GlobalSection(ProjectConfigurationPlatforms) = postSolution
+ {AC231A51-EF60-437C-A33F-AF8ADEB8EB74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {AC231A51-EF60-437C-A33F-AF8ADEB8EB74}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {AC231A51-EF60-437C-A33F-AF8ADEB8EB74}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {AC231A51-EF60-437C-A33F-AF8ADEB8EB74}.Release|Any CPU.Build.0 = Release|Any CPU
+ EndGlobalSection
+ GlobalSection(SolutionProperties) = preSolution
+ HideSolutionNode = FALSE
+ EndGlobalSection
+EndGlobal
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="3.5" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+ <PropertyGroup>
+ <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+ <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+ <ProductVersion>9.0.21022</ProductVersion>
+ <SchemaVersion>2.0</SchemaVersion>
+ <ProjectGuid>{AC231A51-EF60-437C-A33F-AF8ADEB8EB74}</ProjectGuid>
+ <OutputType>Library</OutputType>
+ <AppDesignerFolder>Properties</AppDesignerFolder>
+ <RootNamespace>DotNetOpenId.BuildTasks</RootNamespace>
+ <AssemblyName>DotNetOpenId.BuildTasks</AssemblyName>
+ <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
+ <FileAlignment>512</FileAlignment>
+ </PropertyGroup>
+ <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+ <DebugSymbols>true</DebugSymbols>
+ <DebugType>full</DebugType>
+ <Optimize>false</Optimize>
+ <OutputPath>..\..\bin\Debug\</OutputPath>
+ <DefineConstants>DEBUG;TRACE</DefineConstants>
+ <ErrorReport>prompt</ErrorReport>
+ <WarningLevel>4</WarningLevel>
+ </PropertyGroup>
+ <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+ <DebugType>pdbonly</DebugType>
+ <Optimize>true</Optimize>
+ <OutputPath>..\..\bin\Release\</OutputPath>
+ <DefineConstants>TRACE</DefineConstants>
+ <ErrorReport>prompt</ErrorReport>
+ <WarningLevel>4</WarningLevel>
+ </PropertyGroup>
+ <ItemGroup>
+ <Reference Include="Microsoft.Build.Framework" />
+ <Reference Include="Microsoft.Build.Utilities.v3.5">
+ <RequiredTargetFramework>3.5</RequiredTargetFramework>
+ </Reference>
+ <Reference Include="System" />
+ <Reference Include="System.Core">
+ <RequiredTargetFramework>3.5</RequiredTargetFramework>
+ </Reference>
+ <Reference Include="System.Data" />
+ <Reference Include="System.Xml" />
+ </ItemGroup>
+ <ItemGroup>
+ <Compile Include="SetEnvironmentVariable.cs" />
+ <Compile Include="Properties\AssemblyInfo.cs" />
+ </ItemGroup>
+ <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+ <!-- To modify your build process, add your task inside one of the targets below and uncomment it.
+ Other similar extension points exist, see Microsoft.Common.targets.
+ <Target Name="BeforeBuild">
+ </Target>
+ <Target Name="AfterBuild">
+ </Target>
+ -->
+</Project>
@@ -0,0 +1,36 @@
+using System.Reflection;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+
+// General Information about an assembly is controlled through the following
+// set of attributes. Change these attribute values to modify the information
+// associated with an assembly.
+[assembly: AssemblyTitle("CustomMsBuildTasks")]
+[assembly: AssemblyDescription("")]
+[assembly: AssemblyConfiguration("")]
+[assembly: AssemblyCompany("")]
+[assembly: AssemblyProduct("CustomMsBuildTasks")]
+[assembly: AssemblyCopyright("Copyright © 2008")]
+[assembly: AssemblyTrademark("")]
+[assembly: AssemblyCulture("")]
+
+// Setting ComVisible to false makes the types in this assembly not visible
+// to COM components. If you need to access a type in this assembly from
+// COM, set the ComVisible attribute to true on that type.
+[assembly: ComVisible(false)]
+
+// The following GUID is for the ID of the typelib if this project is exposed to COM
+[assembly: Guid("952e3aaa-5dc6-4b71-8c9c-6b485263be19")]
+
+// Version information for an assembly consists of the following four values:
+//
+// Major Version
+// Minor Version
+// Build Number
+// Revision
+//
+// You can specify all the values or you can default the Build and Revision Numbers
+// by using the '*' as shown below:
+// [assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("1.0.0.0")]
+[assembly: AssemblyFileVersion("1.0.0.0")]
@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Microsoft.Build.Utilities;
+using Microsoft.Build.Framework;
+
+namespace DotNetOpenId.BuildTasks {
+ public class SetEnvironmentVariable : Task {
+ public SetEnvironmentVariable() {
+ Scope = EnvironmentVariableTarget.Process;
+ }
+
+ /// <summary>
+ /// The name of the environment variable to set or clear.
+ /// </summary>
+ [Required]
+ public string Name { get; set; }
+ /// <summary>
+ /// The value of the environment variable, or the empty string to clear it.
+ /// </summary>
+ [Required]
+ public string Value { get; set; }
+ /// <summary>
+ /// The target environment for the variable. Machine, User, or Process.
+ /// </summary>
+ public EnvironmentVariableTarget Scope { get; set; }
+
+ public override bool Execute() {
+ Environment.SetEnvironmentVariable(Name, Value, Scope);
+ return true;
+ }
+ }
+}
@@ -0,0 +1 @@
+Data
@@ -0,0 +1,20 @@
+
+# Sandcastle build script overrides for prototype doc model.
+
+. $DxRoot\Presentation\Shared\SharedDocModel.ps1
+
+function PostProcessReflectionData($sourceFile, $targetFile) {
+ WriteInfo "Post processing reflection data."
+ &$XslTransform $sourceFile `
+ /xsl:$DxRoot\ProductionTransforms\ApplyPrototypeDocModel.xsl `
+ /xsl:$DxRoot\ProductionTransforms\AddGuidFilenames.xsl `
+ /out:$targetFile
+}
+
+function CreateToc {
+ WriteInfo "Creating TOC."
+ &$XslTransform $TempDir\ReflectionData\targets.xml `
+ /xsl:$DxRoot\ProductionTransforms\createPrototypeToc.xsl `
+ /out:$TempDir\toc.xml
+}
+
@@ -0,0 +1,100 @@
+<configuration>
+ <dduetools>
+ <builder>
+ <components>
+
+ <!-- Create skeleton document -->
+ <component type="Microsoft.Ddue.Tools.CopyFromFileComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <data file="%DXROOT%\Presentation\Prototype\transforms\skeleton_conceptual.xml" />
+ <copy source="/*" target="/" />
+ </component>
+
+ <!-- Copy in comments -->
+ <component type="Microsoft.Ddue.Tools.CopyFromIndexComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <index name="comments" value="/topic" key="@id">
+ <data files=".\DdueXml\*.xml" />
+ </index>
+ <copy name="comments" source="/topic" target="/document" />
+ </component>
+
+ <!-- resolve tokens -->
+ <component type="Microsoft.Ddue.Tools.SharedContentComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <context prefix="ddue" name="http://ddue.schemas.microsoft.com/authoring/2003/5" />
+ <content file="%DXROOT%\Data\tokens.xml" />
+ <replace elements="/*//ddue:token" item="string(.)" />
+ </component>
+
+ <!-- copy in metadata keywords -->
+ <component type="Microsoft.Ddue.Tools.CopyFromFilesComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <copy base=".\XmlComp" file="concat($key,'.cmp.xml')" source="/metadata/topic[@id=$key]/*" target="/document/metadata" />
+ </component>
+
+ <!-- copy in metadata attributes -->
+ <component type="Microsoft.Ddue.Tools.CopyFromIndexComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <index name="metadata" value="/metadata/topic" key="@id">
+ <data files=".\ExtractedFiles\*.ContentMetadata.xml" />
+ </index>
+ <copy name="metadata" source="*" target="/document/metadata" />
+ <copy name="metadata" key="string('*')" source="*" target="/document/metadata" />
+ </component>
+
+ <!-- Resolve code snippets -->
+ <component type="Microsoft.Ddue.Tools.ExampleComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <examples file="%DXROOT%\Data\CodeSnippet.xml" />
+ <colors language="VisualBasic">
+ <color pattern="^\s*'[^\r\n]*" class="comment" />
+ <color pattern="\&#34;.*\&#34;" class="literal" />
+ <color pattern="\b((AddHandler)|(AddressOf)|(As)|(ByRef)|(ByVal)|(Case)|(Catch)|(Class)|(Const)|(Continue)|(Delegate)|(Dim)|(Each)|(Else)|(ElseIf)|(End)|(Enum)|(Event)|(Exit)|(False)|(Finally)|(For)|(Friend)|(Function)|(Get)|(Handles)|(Implements)|(Imports)|(In)|(Inherits)|(Interface)|(Is)|(Loop)|(Me)|(Module)|(MustInherit)|(MustOverride)|(MyBase)|(Namespace)|(New)|(Next)|(Nothing)|(NotInheritable)|(NotOverrideable)|(Of)|(Overloads)|(Overridable)|(Overrides)|(ParamArray)|(Partial)|(Private)|(Property)|(Protected)|(Public)|(RaiseEvent)|(ReadOnly)|(RemoveHandler)|(Set)|(Shadows)|(Shared)|(Static)|(Step)|(Structure)|(Sub)|(Then)|(Throw)|(To)|(True)|(Try)|(Until)|(Using)|(When)|(While)|(With)|(WriteOnly))\b" class="keyword" />
+ </colors>
+ <colors language="CSharp">
+ <color pattern="/\*(.|\n)+?\*/" class="comment" />
+ <color pattern="//[^\r\n]*" class="comment" />
+ <color pattern="\&#34;.*\&#34;" class="literal" />
+ <color pattern="\b((abstract)|(as)|(base)|(bool)|(break)|(case)|(catch)|(class)|(const)|(continue)|(default)|(delegate)|(do)|(else)|(enum)|(event)|(extern)|(false)|(finally)|(for)|(foreach)|(get)|(if)|(in)|(interface)|(internal)|(is)|(namespace)|(new)|(null)|(out)|(override)|(params)|(private)|(protected)|(public)|(readonly)|(ref)|(return)|(sealed)|(set)|(static)|(struct)|(switch)|(this)|(throw)|(true)|(try)|(typeof)|(using)|(virtual)|(volatile)|(void)|(while))\b" class="keyword" />
+ </colors>
+ <colors language="ManagedCPlusPlus">
+ <color pattern="/\*(.|\n)+?\*/" class="comment" />
+ <color pattern="//[^\r\n]*" class="comment" />
+ <color pattern="\&#34;.*\&#34;" class="literal" />
+ <color pattern="\b((abstract)|(array)|(break)|(case)|(catch)|(class)|(const)|(continue)|(delegate)|(delete)|(do)|(else)|(enum)|(event)|(extern)|(false)|(finally)|(for)|(friend)|(gcnew)|(generic)|(goto)|(if)|(initonly)|(inline)|(interface)|(literal)|(namespace)|(new)|(noinline)|(nullptr)|(operator)|(private)|(property)|(protected)|(public)|(ref)|(register)|(return)|(sealed)|(sizeof)|(static)|(struct)|(switch)|(template)|(this)|(throw)|(true)|(try)|(typedef)|(union)|(using)|(value)|(virtual)|(void)|(volatile)|(while))\b" class="keyword" />
+ </colors>
+ </component>
+
+ <!--
+ <component type="Microsoft.Ddue.Tools.DisplayComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <xpath>/</xpath>
+ </component>
+ -->
+
+ <!-- transform -->
+ <component type="Microsoft.Ddue.Tools.TransformComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <transform file="%DXROOT%\Presentation\Prototype\transforms\main_conceptual.xsl" />
+ </component>
+
+ <!-- resolve art links -->
+ <component type="Microsoft.Ddue.Tools.ResolveArtLinksComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <targets input="%DXROOT%\Data\ArtStore" output=".\Output\media" link="../media" map="%DXROOT%\Data\ArtSharedContent.loc.xml" />
+ </component>
+
+ <!-- resolve shared content -->
+ <component type="Microsoft.Ddue.Tools.SharedContentComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <content file="%DXROOT%\Presentation\Prototype\content\shared_content.xml" />
+ <content file="%DXROOT%\Presentation\Prototype\content\conceptual_content.xml" />
+ </component>
+
+ <!-- resolve conceptual links -->
+ <component type="Microsoft.Ddue.Tools.ResolveConceptualLinksComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <targets base=".\XmlComp" type="local" />
+ <targets base="%DXROOT%\Data\XmlComp" type="index"/>
+ </component>
+
+ <!-- save the result -->
+ <component type="Microsoft.Ddue.Tools.SaveComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
+ <save base=".\Output\html" path="concat($key,'.htm')" indent="true" omit-xml-declaration="true" />
+ </component>
+
+ </components>
+
+ </builder>
+ </dduetools>
+</configuration>
Oops, something went wrong.

0 comments on commit 02d5eb1

Please sign in to comment.