Skip to content

Commit 9af5ff1

Browse files
committed
Sandcastle documentation project updates
- Add a project reference to corelib to ensure that the SDK is built before the documentation project - Enable the IntelliSense Component to generate a transformed XML documentation file - Modify the syntax filters to use the same languages as MSDN: C#, VB, C++, and F# - Modify the visible items filter to only include items visible from outside the library (no private or internal members, and document protected internal members as protected)
1 parent aff03bd commit 9af5ff1

2 files changed

Lines changed: 18 additions & 3 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ TestResults
5959
*.shfbproj_*
6060

6161
# Sandcastle Output
62+
docs/Api/
6263
docs/html/
6364

6465
#NuGet
65-
*.nupkg
66+
*.nupkg

src/Documentation/Documentation.shfbproj

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
3030
<CppCommentsFixup>False</CppCommentsFixup>
3131
<CleanIntermediates>True</CleanIntermediates>
32-
<SyntaxFilters>CSharp, VisualBasic, CPlusPlus, JavaScript, AspNet</SyntaxFilters>
32+
<SyntaxFilters>CSharp, VisualBasic, CPlusPlus, FSharp</SyntaxFilters>
3333
<SdkLinkTarget>Blank</SdkLinkTarget>
3434
<RootNamespaceContainer>True</RootNamespaceContainer>
3535
<PresentationStyle>VS2010</PresentationStyle>
@@ -42,7 +42,7 @@
4242
<HtmlSdkLinkType>Msdn</HtmlSdkLinkType>
4343
<IncludeFavorites>True</IncludeFavorites>
4444
<BinaryTOC>True</BinaryTOC>
45-
<VisibleItems>Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Internals, Privates, Protected, SealedProtected, InheritedFrameworkPrivateMembers, InheritedFrameworkInternalMembers</VisibleItems>
45+
<VisibleItems>Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected, SealedProtected</VisibleItems>
4646
<FeedbackEMailAddress>openstack.net%40lists.rackspace.com</FeedbackEMailAddress>
4747
<CopyrightText>
4848
</CopyrightText>
@@ -56,6 +56,13 @@
5656
<Argument Key="logoPlacement" Value="left" />
5757
<Argument Key="logoAlignment" Value="left" />
5858
</TransformComponentArguments>
59+
<ComponentConfigurations>
60+
<ComponentConfig id="IntelliSense Component" enabled="True" xmlns="">
61+
<component id="IntelliSense Component" type="Microsoft.Ddue.Tools.IntelliSenseComponent" assembly="{@SandcastlePath}ProductionTools\BuildComponents.dll">
62+
<output includeNamespaces="false" namespacesFile="Namespaces" folder="{@OutputFolder}\..\Api" />
63+
</component>
64+
</ComponentConfig>
65+
</ComponentConfigurations>
5966
</PropertyGroup>
6067
<!-- There are no properties for these groups. AnyCPU needs to appear in
6168
order for Visual Studio to perform the build. The others are optional
@@ -76,6 +83,13 @@
7683
</PropertyGroup>
7784
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
7885
</PropertyGroup>
86+
<ItemGroup>
87+
<ProjectReference Include="..\corelib\corelib.csproj">
88+
<Name>corelib</Name>
89+
<Project>{7dba11eb-dba7-4d3a-8d42-b5312e74b9c0}</Project>
90+
<Private>True</Private>
91+
</ProjectReference>
92+
</ItemGroup>
7993
<!-- Import the SHFB build targets -->
8094
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
8195
</Project>

0 commit comments

Comments
 (0)