forked from dotnet/docfx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic folder layout and BackEnd projects to solution
- Loading branch information
0 parents
commit 7e311fd
Showing
142 changed files
with
19,209 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| ############### | ||
| # folder # | ||
| ############### | ||
| /**/DROP/ | ||
| /**/TEMP/ | ||
| /**/packages/ | ||
| /**/bin/ | ||
| /**/csx/ | ||
| /**/obj/ | ||
| /**/xdocoutput/ | ||
| /**/node_modules/ | ||
| /**/*.sln.ide/ | ||
| /TestResults/ | ||
| /.vs/ | ||
|
|
||
| ############### | ||
| # temp file # | ||
| ############### | ||
| *.nupkg | ||
| *.log | ||
| *.tmp | ||
| *.vsprops | ||
| *.suo | ||
| *.user | ||
| *.userprefs | ||
| *.suo | ||
| *.sln.ide | ||
| *.cache | ||
| *.sln.metaproj | ||
| .gitattributes | ||
| .settings | ||
| log.txt | ||
| debugSettings.json | ||
| launchSettings.json | ||
| project.lock.json | ||
| nuget.exe | ||
| *.sublime-workspace | ||
|
|
||
|
|
||
| ############################ | ||
| # wix intermediate files # | ||
| ############################ | ||
| Installer/obj/ | ||
| Installer/*.wixpdb | ||
| Installer/*.wixobj | ||
| Installer/*.msi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
|
|
||
| Microsoft Visual Studio Solution File, Format Version 12.00 | ||
| # Visual Studio 14 | ||
| VisualStudioVersion = 14.0.22919.0 | ||
| MinimumVisualStudioVersion = 10.0.40219.1 | ||
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docfx", "src\BackEnd\docfx\docfx.csproj", "{AB97BEDF-D207-42E9-A56F-C9DD395BFCDD}" | ||
| EndProject | ||
| Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "BackEnd", "BackEnd", "{2DAAC304-36F6-4E4A-A0EA-5821B4B9842A}" | ||
| EndProject | ||
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.CodeAnalysis.Workspaces.Dnx", "src\BackEnd\Microsoft.CodeAnalysis.Workspaces.Dnx\Microsoft.CodeAnalysis.Workspaces.Dnx.csproj", "{5A876EC5-D4D2-4160-9A03-AA0245C322F4}" | ||
| EndProject | ||
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.DocAsCode.EntityModel", "src\BackEnd\Microsoft.DocAsCode.EntityModel\Microsoft.DocAsCode.EntityModel.csproj", "{A4BE543D-2CF1-40AB-9889-E9E48CBF7DFE}" | ||
| EndProject | ||
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.DocAsCode.Utility", "src\BackEnd\Microsoft.DocAsCode.Utility\Microsoft.DocAsCode.Utility.csproj", "{619EC13D-8939-4F23-B7DC-7A98964BB9A4}" | ||
| EndProject | ||
| Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{6A65A769-DAC3-4E99-96F9-991F4CE8D164}" | ||
| EndProject | ||
| Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{3E93DD37-948B-41CF-8C91-892B36B07E58}" | ||
| EndProject | ||
| Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{E872B0D7-6331-4E40-8264-0015330DA5D3}" | ||
| EndProject | ||
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docs", "docs\docs.csproj", "{84CB177E-6888-482A-9803-7CA850B8EF3B}" | ||
| EndProject | ||
| Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "BackEndDnx", "BackEndDnx", "{38490932-E9E7-4C31-81DD-B4B06BACD1BB}" | ||
| EndProject | ||
| Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "docfx", "src\BackEnd\docfx\docfx.xproj", "{2F00F297-9231-4906-AE78-DA114AD19E01}" | ||
| EndProject | ||
| Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.CodeAnalysis.Workspaces.Dnx", "src\BackEnd\Microsoft.CodeAnalysis.Workspaces.Dnx\Microsoft.CodeAnalysis.Workspaces.Dnx.xproj", "{F1790843-ED2B-4517-B3EA-A14B3A15969B}" | ||
| EndProject | ||
| Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.DocAsCode.Utility", "src\BackEnd\Microsoft.DocAsCode.Utility\Microsoft.DocAsCode.Utility.xproj", "{AD097A5F-F82C-4EB9-869B-10AB61E5301F}" | ||
| EndProject | ||
| Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.DocAsCode.EntityModel", "src\BackEnd\Microsoft.DocAsCode.EntityModel\Microsoft.DocAsCode.EntityModel.xproj", "{AAA7BF52-90BE-44DD-8996-17A16311B6C1}" | ||
| EndProject | ||
| Global | ||
| GlobalSection(SolutionConfigurationPlatforms) = preSolution | ||
| Debug|Any CPU = Debug|Any CPU | ||
| Release|Any CPU = Release|Any CPU | ||
| EndGlobalSection | ||
| GlobalSection(ProjectConfigurationPlatforms) = postSolution | ||
| {AB97BEDF-D207-42E9-A56F-C9DD395BFCDD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {AB97BEDF-D207-42E9-A56F-C9DD395BFCDD}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {AB97BEDF-D207-42E9-A56F-C9DD395BFCDD}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {AB97BEDF-D207-42E9-A56F-C9DD395BFCDD}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {5A876EC5-D4D2-4160-9A03-AA0245C322F4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {5A876EC5-D4D2-4160-9A03-AA0245C322F4}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {5A876EC5-D4D2-4160-9A03-AA0245C322F4}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {5A876EC5-D4D2-4160-9A03-AA0245C322F4}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {A4BE543D-2CF1-40AB-9889-E9E48CBF7DFE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {A4BE543D-2CF1-40AB-9889-E9E48CBF7DFE}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {A4BE543D-2CF1-40AB-9889-E9E48CBF7DFE}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {A4BE543D-2CF1-40AB-9889-E9E48CBF7DFE}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {619EC13D-8939-4F23-B7DC-7A98964BB9A4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {619EC13D-8939-4F23-B7DC-7A98964BB9A4}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {619EC13D-8939-4F23-B7DC-7A98964BB9A4}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {619EC13D-8939-4F23-B7DC-7A98964BB9A4}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {84CB177E-6888-482A-9803-7CA850B8EF3B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {84CB177E-6888-482A-9803-7CA850B8EF3B}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {84CB177E-6888-482A-9803-7CA850B8EF3B}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {84CB177E-6888-482A-9803-7CA850B8EF3B}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {2F00F297-9231-4906-AE78-DA114AD19E01}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {2F00F297-9231-4906-AE78-DA114AD19E01}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {2F00F297-9231-4906-AE78-DA114AD19E01}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {2F00F297-9231-4906-AE78-DA114AD19E01}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {F1790843-ED2B-4517-B3EA-A14B3A15969B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {F1790843-ED2B-4517-B3EA-A14B3A15969B}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {F1790843-ED2B-4517-B3EA-A14B3A15969B}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {F1790843-ED2B-4517-B3EA-A14B3A15969B}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {AD097A5F-F82C-4EB9-869B-10AB61E5301F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {AD097A5F-F82C-4EB9-869B-10AB61E5301F}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {AD097A5F-F82C-4EB9-869B-10AB61E5301F}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {AD097A5F-F82C-4EB9-869B-10AB61E5301F}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| {AAA7BF52-90BE-44DD-8996-17A16311B6C1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {AAA7BF52-90BE-44DD-8996-17A16311B6C1}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {AAA7BF52-90BE-44DD-8996-17A16311B6C1}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {AAA7BF52-90BE-44DD-8996-17A16311B6C1}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| EndGlobalSection | ||
| GlobalSection(SolutionProperties) = preSolution | ||
| HideSolutionNode = FALSE | ||
| EndGlobalSection | ||
| GlobalSection(NestedProjects) = preSolution | ||
| {AB97BEDF-D207-42E9-A56F-C9DD395BFCDD} = {2DAAC304-36F6-4E4A-A0EA-5821B4B9842A} | ||
| {2DAAC304-36F6-4E4A-A0EA-5821B4B9842A} = {6A65A769-DAC3-4E99-96F9-991F4CE8D164} | ||
| {5A876EC5-D4D2-4160-9A03-AA0245C322F4} = {2DAAC304-36F6-4E4A-A0EA-5821B4B9842A} | ||
| {A4BE543D-2CF1-40AB-9889-E9E48CBF7DFE} = {2DAAC304-36F6-4E4A-A0EA-5821B4B9842A} | ||
| {619EC13D-8939-4F23-B7DC-7A98964BB9A4} = {2DAAC304-36F6-4E4A-A0EA-5821B4B9842A} | ||
| {84CB177E-6888-482A-9803-7CA850B8EF3B} = {3E93DD37-948B-41CF-8C91-892B36B07E58} | ||
| {38490932-E9E7-4C31-81DD-B4B06BACD1BB} = {6A65A769-DAC3-4E99-96F9-991F4CE8D164} | ||
| {2F00F297-9231-4906-AE78-DA114AD19E01} = {38490932-E9E7-4C31-81DD-B4B06BACD1BB} | ||
| {F1790843-ED2B-4517-B3EA-A14B3A15969B} = {38490932-E9E7-4C31-81DD-B4B06BACD1BB} | ||
| {AD097A5F-F82C-4EB9-869B-10AB61E5301F} = {38490932-E9E7-4C31-81DD-B4B06BACD1BB} | ||
| {AAA7BF52-90BE-44DD-8996-17A16311B6C1} = {38490932-E9E7-4C31-81DD-B4B06BACD1BB} | ||
| EndGlobalSection | ||
| EndGlobal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Doc-As-Code | ||
| =========== | ||
| Easily build and publish your API documentation. We currently support C# and VB projects. | ||
|
|
||
| Code Walkthrough Quick Start | ||
| --------------- | ||
| TO BE ADDED |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ECHO TO BE ADDED |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| 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("docs")] | ||
| [assembly: AssemblyDescription("")] | ||
| [assembly: AssemblyConfiguration("")] | ||
| [assembly: AssemblyCompany("")] | ||
| [assembly: AssemblyProduct("docs")] | ||
| [assembly: AssemblyCopyright("Microsoft DocAsCode Copyright © 2015")] | ||
| [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("84cb177e-6888-482a-9803-7ca850b8ef3b")] | ||
|
|
||
| // 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 Revision and Build Numbers | ||
| // by using the '*' as shown below: | ||
| [assembly: AssemblyVersion("1.0.0.0")] | ||
| [assembly: AssemblyFileVersion("1.0.0.0")] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
|
|
||
| --- | ||
| uid: DocAsCode.EntityModel.BuildMetaHelper | ||
| remarks: '*THIS* is remarks overriden in *MARKDWON* file' | ||
| --- | ||
|
|
||
| Expresses static methods for creating, moving, and enumerating through directories and subdirectories. This class cannot be inherited. | ||
| To browse the .NET Framework source code for this type, see the [Reference Source](http://referencesource.microsoft.com/#mscorlib/system/io/directory.cs) | ||
|
|
||
| Refer to @DocAsCode.EntityModel.ProjectLevelCache to see what to do with **Files** | ||
|
|
||
| Here is a code snippet to use Directory: | ||
|
|
||
| ````csharp | ||
| {{'../../BackEnd\UnitTest/CommonUtiiltyUnitTest.cs'[20-60]}} | ||
| ```` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
| <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" /> | ||
| <PropertyGroup> | ||
| <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration> | ||
| <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform> | ||
| <ProductVersion> | ||
| </ProductVersion> | ||
| <SchemaVersion>2.0</SchemaVersion> | ||
| <ProjectGuid>{84CB177E-6888-482A-9803-7CA850B8EF3B}</ProjectGuid> | ||
| <ProjectTypeGuids>{349c5851-65df-11da-9384-00065b846f21};{fae04ec0-301f-11d3-bf4b-00c04f79efbc}</ProjectTypeGuids> | ||
| <OutputType>Library</OutputType> | ||
| <AppDesignerFolder>Properties</AppDesignerFolder> | ||
| <RootNamespace>Documentation</RootNamespace> | ||
| <AssemblyName>Documentation</AssemblyName> | ||
| <TargetFrameworkVersion>v4.5.2</TargetFrameworkVersion> | ||
| <UseIISExpress>true</UseIISExpress> | ||
| <IISExpressSSLPort /> | ||
| <IISExpressAnonymousAuthentication /> | ||
| <IISExpressWindowsAuthentication /> | ||
| <IISExpressUseClassicPipelineMode /> | ||
| <UseGlobalApplicationHostFile /> | ||
| <NuGetPackageImportStamp> | ||
| </NuGetPackageImportStamp> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' "> | ||
| <DebugSymbols>true</DebugSymbols> | ||
| <DebugType>full</DebugType> | ||
| <Optimize>false</Optimize> | ||
| <OutputPath>bin\</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\</OutputPath> | ||
| <DefineConstants>TRACE</DefineConstants> | ||
| <ErrorReport>prompt</ErrorReport> | ||
| <WarningLevel>4</WarningLevel> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <Reference Include="Microsoft.CSharp" /> | ||
| <Reference Include="System.Web.DynamicData" /> | ||
| <Reference Include="System.Web.Entity" /> | ||
| <Reference Include="System.Web.ApplicationServices" /> | ||
| <Reference Include="System.ComponentModel.DataAnnotations" /> | ||
| <Reference Include="System" /> | ||
| <Reference Include="System.Data" /> | ||
| <Reference Include="System.Core" /> | ||
| <Reference Include="System.Data.DataSetExtensions" /> | ||
| <Reference Include="System.Web.Extensions" /> | ||
| <Reference Include="System.Xml.Linq" /> | ||
| <Reference Include="System.Drawing" /> | ||
| <Reference Include="System.Web" /> | ||
| <Reference Include="System.Xml" /> | ||
| <Reference Include="System.Configuration" /> | ||
| <Reference Include="System.Web.Services" /> | ||
| <Reference Include="System.EnterpriseServices" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="toc.yml" /> | ||
| <Content Include="xdoc.json" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="Properties\AssemblyInfo.cs" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="tutorial\docfx.exe_user_manual.md" /> | ||
| <Content Include="tutorial\docfx_getting_started.md" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="specs\docfx_incremental.md" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="specs\mapfile_format_spec.md" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="specs\metadata_dotnet_spec.md" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="specs\metadata_format_spec.md" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="specs\toc.yml" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="..\README.md"> | ||
| <Link>README.md</Link> | ||
| </Content> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="apispecs\BuildMetaHelper.md" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="packages.config"> | ||
| <SubType>Designer</SubType> | ||
| </Content> | ||
| </ItemGroup> | ||
| <PropertyGroup> | ||
| <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion> | ||
| <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath> | ||
| </PropertyGroup> | ||
| <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" /> | ||
| <Import Project="$(VSToolsPath)\WebApplications\Microsoft.WebApplication.targets" Condition="'$(VSToolsPath)' != ''" /> | ||
| <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v10.0\WebApplications\Microsoft.WebApplication.targets" Condition="false" /> | ||
| <ProjectExtensions> | ||
| <VisualStudio> | ||
| <FlavorProperties GUID="{349c5851-65df-11da-9384-00065b846f21}"> | ||
| <WebProjectProperties> | ||
| <UseIIS>True</UseIIS> | ||
| <AutoAssignPort>True</AutoAssignPort> | ||
| <DevelopmentServerPort>23910</DevelopmentServerPort> | ||
| <DevelopmentServerVPath>/</DevelopmentServerVPath> | ||
| <IISUrl>http://localhost:23910/</IISUrl> | ||
| <NTLMAuthentication>False</NTLMAuthentication> | ||
| <UseCustomServer>False</UseCustomServer> | ||
| <CustomServerUrl> | ||
| </CustomServerUrl> | ||
| <SaveServerSettingsInUserFile>False</SaveServerSettingsInUserFile> | ||
| </WebProjectProperties> | ||
| </FlavorProperties> | ||
| </VisualStudio> | ||
| </ProjectExtensions> | ||
| <!-- 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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <packages> | ||
| </packages> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| Doc-as-code: DocFx.exe Incremental Build Specification | ||
| ========================================== | ||
|
|
||
| This documentation describes the implementation of incrementally extracting metadata from source. Currently we are using *Roslyn* to compile and analysis source code on the fly. When input sources are large, it may take minutes to load and process the files. To speed up the extraction, previous extracted details are saved to cache for further reference. | ||
|
|
||
| There are two level caches in current implementation. First one is called *Application* Level cache, and the other one is *Project* level cache. | ||
|
|
||
| *Application* level cache is saved in file `%LocalAppData%/xdoc/cache`. | ||
|
|
||
| For *Project* level cache, | ||
|
|
||
| a. If input sources are supported project files, e.g. `.csproj` or `.vbproj` files, *Project* level cache is located in file `obj/xdoc/.cache` under the same folder of the project file. | ||
|
|
||
| b. If input sources are supported source code files, e.g. `.cs` or `.vb` files, *Project* level cache is located in file `obj/xdoc/.cache` under the same folder of the alphabetically first source code file. | ||
|
|
||
| The cache file contains key-value pairs saved in *JSON* format. The key is the normalized input source code files, and the data structure for the value is as below: | ||
|
|
||
| Property | Description | ||
| ---------------------|-------------------------- | ||
| TriggeredUTCTime | The UTC time when the action is triggered | ||
| CompletedUTCTime | The UTC time when the action is completed | ||
| OutputFolder | The output folder for the extracted result | ||
| RelativeOutputFiles | The paths of the extracted results related to the *OutputFolder* | ||
| CheckSum | The MD5 checksum calculated for all the extracted results | ||
|
|
||
| Detailed Steps are described below: | ||
| 1. For each input solution/project/source files, get most latest `LastModifiedTime`. | ||
| a. For solution, get `LastModifiedTime` for the solution file, and containing projects | ||
| b. For project, get `LastModifiedTime` for the project file, project references, assembly references and containing documents. | ||
| c. For source files, get `LastModifiedTime` for the files | ||
| 2. Normalize project list, check if *Application* level cache for these project list exists. Compare `TriggeredUTCTime` with the `LastModifiedTime` fetched in #1, and check if checksum remains unchanged for output files. If is, copy result files to output folder. Otherwise, continue to #3. | ||
|
|
||
| 3. For each supported solution/project/source code files, | ||
|
|
||
| *Step 1*. Check if *Project* level cache exists. If not, go to *Step 4*. | ||
|
|
||
| *Step 2*. Compare `TriggeredUTCTime` with the `LastModifiedTime` fetched in #1, and check if checksum remains unchanged for output files. If not, go to *Step 3*. | ||
|
|
||
| *Step 3*. Generate YAML metadata for current project and save to *Project* level cache. | ||
|
|
||
| 4. Read YAML metadata for each project, and merge with others following rules below: | ||
|
|
||
| *Rule 1*. For `namespace`, if `uid` equals, **append**. | ||
|
|
||
| *Rule 2*. For other type, if `uid` equals, **override**. | ||
|
|
||
| 5. Save result, and update **Application* level cache. |
Oops, something went wrong.