Skip to content

Commit 4fd5fae

Browse files
brianjmillerbrianjmiller
committed
Documentation project setup
1 parent a92743f commit 4fd5fae

File tree

9 files changed

+191
-0
lines changed

9 files changed

+191
-0
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@ UpgradeLog*.XML
110110
#Ignore generated nupkg files
111111
*.nupkg
112112

113+
#Ignore generated documentation files
114+
Doc/Help/
115+
113116
.DS_Store
114117
*.swp
115118
tmp/

‎Doc/Content/VersionHistory/VersionHistory.aml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="fb79821f-fa92-4942-9981-6c184b817059" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<introduction>
5+
<para>The topics in this section describe the various changes made to the TinCan.NET over the life of the project.</para>
6+
</introduction>
7+
8+
<section>
9+
<title>Version History</title>
10+
<content>
11+
<para>Select a version below to see a description of its changes.</para>
12+
13+
<list class="bullet">
14+
<listItem>
15+
<para><link xlink:href="98884de4-4d4a-4365-9f35-e34042e52a60" /></para>
16+
</listItem>
17+
</list>
18+
</content>
19+
</section>
20+
21+
<relatedTopics>
22+
<link xlink:href="dc851e6b-b0f8-43e4-9c96-42f33a792d93" />
23+
</relatedTopics>
24+
25+
</developerConceptualDocument>
26+
</topic>

‎Doc/Content/VersionHistory/v0.0.1.0.aml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="98884de4-4d4a-4365-9f35-e34042e52a60" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<introduction>
5+
<para>Version 0.0.1.0 was released on 2014-04-28.
6+
</para>
7+
</introduction>
8+
9+
<section>
10+
<title>Changes in This Release</title>
11+
<content>
12+
13+
<list class="bullet">
14+
<listItem>
15+
<para>This is the initial release, basic implementation in place.</para>
16+
</listItem>
17+
18+
</list>
19+
20+
</content>
21+
</section>
22+
23+
<relatedTopics>
24+
<link xlink:href="fb79821f-fa92-4942-9981-6c184b817059" />
25+
</relatedTopics>
26+
27+
</developerConceptualDocument>
28+
</topic>

‎Doc/Content/Welcome.aml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="dc851e6b-b0f8-43e4-9c96-42f33a792d93" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<introduction>
5+
<para>This is the autogenerated API documentation for the TinCan.NET open source library.</para>
6+
</introduction>
7+
8+
<section>
9+
<title>Getting Started</title>
10+
<content>
11+
<para>These documentation pages are a work in progress. Pull requests are accepted.</para>
12+
</content>
13+
</section>
14+
15+
<relatedTopics>
16+
<link xlink:href="fb79821f-fa92-4942-9981-6c184b817059" />
17+
</relatedTopics>
18+
</developerConceptualDocument>
19+
</topic>

‎Doc/ContentLayout.content‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Topics>
3+
<Topic id="dc851e6b-b0f8-43e4-9c96-42f33a792d93" visible="True" isDefault="true" title="TinCan.NET API Documentation">
4+
<HelpKeywords>
5+
<HelpKeyword index="K" term="Welcome" />
6+
</HelpKeywords>
7+
</Topic>
8+
<Topic id="fb79821f-fa92-4942-9981-6c184b817059" visible="True" isExpanded="true" title="Version History">
9+
<HelpKeywords>
10+
<HelpKeyword index="K" term="version, history" />
11+
</HelpKeywords>
12+
<Topic id="98884de4-4d4a-4365-9f35-e34042e52a60" visible="True" isSelected="true" title="Version 0.0.1.0">
13+
<HelpKeywords>
14+
<HelpKeyword index="K" term="version, 1.0.0.0" />
15+
</HelpKeywords>
16+
</Topic>
17+
</Topic>
18+
</Topics>

‎Doc/Doc.shfbproj‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
3+
<PropertyGroup>
4+
<!-- The configuration and platform will be used to determine which assemblies to include from solution and
5+
project documentation sources -->
6+
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
7+
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
8+
<SchemaVersion>2.0</SchemaVersion>
9+
<ProjectGuid>f8d803ad-a192-4f8c-a582-674b75e42995</ProjectGuid>
10+
<SHFBSchemaVersion>1.9.9.0</SHFBSchemaVersion>
11+
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
12+
<AssemblyName>Doc</AssemblyName>
13+
<RootNamespace>Doc</RootNamespace>
14+
<Name>Doc</Name>
15+
<!-- SHFB properties -->
16+
<FrameworkVersion>.NET Framework 3.5</FrameworkVersion>
17+
<OutputPath>.\Help\</OutputPath>
18+
<HtmlHelpName>Doc</HtmlHelpName>
19+
<Language>en-US</Language>
20+
<TransformComponentArguments>
21+
<Argument Key="logoFile" Value="Help.png" xmlns="" />
22+
<Argument Key="logoHeight" Value="" xmlns="" />
23+
<Argument Key="logoWidth" Value="" xmlns="" />
24+
<Argument Key="logoAltText" Value="" xmlns="" />
25+
<Argument Key="logoPlacement" Value="left" xmlns="" />
26+
<Argument Key="logoAlignment" Value="left" xmlns="" />
27+
<Argument Key="maxVersionParts" Value="" xmlns="" />
28+
</TransformComponentArguments>
29+
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
30+
<HelpFileFormat>Website</HelpFileFormat>
31+
<IndentHtml>False</IndentHtml>
32+
<KeepLogFile>True</KeepLogFile>
33+
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
34+
<CppCommentsFixup>False</CppCommentsFixup>
35+
<CleanIntermediates>True</CleanIntermediates>
36+
<DocumentationSources>
37+
<DocumentationSource sourceFile="..\TinCan\TinCan.csproj" xmlns="" />
38+
</DocumentationSources>
39+
<MaximumGroupParts>2</MaximumGroupParts>
40+
<NamespaceGrouping>False</NamespaceGrouping>
41+
<SyntaxFilters>Standard</SyntaxFilters>
42+
<SdkLinkTarget>Blank</SdkLinkTarget>
43+
<RootNamespaceContainer>False</RootNamespaceContainer>
44+
<PresentationStyle>VS2005</PresentationStyle>
45+
<Preliminary>False</Preliminary>
46+
<NamingMethod>Guid</NamingMethod>
47+
<HelpTitle>TinCan.NET API Documentation</HelpTitle>
48+
<ContentPlacement>AboveNamespaces</ContentPlacement>
49+
<FeedbackEMailLinkText>support%40tincanapi.com</FeedbackEMailLinkText>
50+
<FeedbackEMailAddress>support%40tincanapi.com</FeedbackEMailAddress>
51+
<CopyrightText>2014 Rustici Software</CopyrightText>
52+
</PropertyGroup>
53+
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
54+
the build. The others are optional common platform types that may appear. -->
55+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
56+
</PropertyGroup>
57+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
58+
</PropertyGroup>
59+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
60+
</PropertyGroup>
61+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
62+
</PropertyGroup>
63+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
64+
</PropertyGroup>
65+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
66+
</PropertyGroup>
67+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
68+
</PropertyGroup>
69+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
70+
</PropertyGroup>
71+
<ItemGroup>
72+
<Folder Include="Content" />
73+
<Folder Include="Content\VersionHistory" />
74+
<Folder Include="icons" />
75+
<Folder Include="Media" />
76+
</ItemGroup>
77+
<ItemGroup>
78+
<None Include="Content\VersionHistory\v0.0.1.0.aml" />
79+
<None Include="Content\VersionHistory\VersionHistory.aml" />
80+
<None Include="Content\Welcome.aml" />
81+
</ItemGroup>
82+
<ItemGroup>
83+
<ContentLayout Include="ContentLayout.content" />
84+
</ItemGroup>
85+
<ItemGroup>
86+
<Content Include="icons\Help.png" />
87+
</ItemGroup>
88+
<!-- Import the SHFB build targets -->
89+
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
90+
</Project>

‎Doc/icons/Help.png‎

3.17 KB
Loading

‎TinCan.sln‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TinCan", "TinCan\TinCan.csp
55
EndProject
66
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TinCanTests", "TinCanTests\TinCanTests.csproj", "{854413C2-2F81-4A82-9949-DE2868A10078}"
77
EndProject
8+
Project("{7CF6DF6D-3B04-46F8-A40B-537D21BCA0B4}") = "Doc", "Doc\Doc.shfbproj", "{F8D803AD-A192-4F8C-A582-674B75E42995}"
9+
EndProject
810
Global
911
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1012
Debug|Any CPU = Debug|Any CPU
@@ -19,6 +21,10 @@ Global
1921
{854413C2-2F81-4A82-9949-DE2868A10078}.Debug|Any CPU.Build.0 = Debug|Any CPU
2022
{854413C2-2F81-4A82-9949-DE2868A10078}.Release|Any CPU.ActiveCfg = Release|Any CPU
2123
{854413C2-2F81-4A82-9949-DE2868A10078}.Release|Any CPU.Build.0 = Release|Any CPU
24+
{F8D803AD-A192-4F8C-A582-674B75E42995}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
25+
{F8D803AD-A192-4F8C-A582-674B75E42995}.Debug|Any CPU.Build.0 = Debug|Any CPU
26+
{F8D803AD-A192-4F8C-A582-674B75E42995}.Release|Any CPU.ActiveCfg = Release|Any CPU
27+
{F8D803AD-A192-4F8C-A582-674B75E42995}.Release|Any CPU.Build.0 = Release|Any CPU
2228
EndGlobalSection
2329
GlobalSection(SolutionProperties) = preSolution
2430
HideSolutionNode = FALSE

‎TinCan/TinCan.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
<DefineConstants>DEBUG;TRACE</DefineConstants>
2121
<ErrorReport>prompt</ErrorReport>
2222
<WarningLevel>4</WarningLevel>
23+
<DocumentationFile>bin\Debug\TinCan.XML</DocumentationFile>
2324
</PropertyGroup>
2425
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
2526
<DebugType>pdbonly</DebugType>

0 commit comments

Comments
 (0)