Skip to content

Commit

Permalink
Add Sandcastle files.
Browse files Browse the repository at this point in the history
  • Loading branch information
yfakariya committed Aug 15, 2012
1 parent 6f870f3 commit 5108a94
Show file tree
Hide file tree
Showing 3 changed files with 176 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
*.csproj.user
*.pidb
*.nupkg
*.shfbproj_*
bin/
Bin/
Help*/
lib/
local/
obj/
Expand Down
81 changes: 81 additions & 0 deletions MsgPack.shfbproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
<PropertyGroup>
<!-- The configuration and platform will be used to determine which
assemblies to include from solution and project documentation
sources -->
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{928e44ef-1824-42ba-b6d2-01363b38ad6c}</ProjectGuid>
<SHFBSchemaVersion>1.9.3.0</SHFBSchemaVersion>
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
Studio adds them anyway -->
<AssemblyName>Documentation</AssemblyName>
<RootNamespace>Documentation</RootNamespace>
<Name>Documentation</Name>
<!-- SHFB properties -->
<OutputPath>.\Help\</OutputPath>
<HtmlHelpName>Documentation</HtmlHelpName>
<Language>en-US</Language>
<NamingMethod>MemberName</NamingMethod>
<Preliminary>True</Preliminary>
<PresentationStyle>vs2010</PresentationStyle>
<RootNamespaceContainer>True</RootNamespaceContainer>
<SdkLinkTarget>Self</SdkLinkTarget>
<SyntaxFilters>CSharp, VisualBasic, CPlusPlus, FSharp</SyntaxFilters>
<ProductTitle>MessagePack for CLI</ProductTitle>
<VendorName>msgpack_org</VendorName>
<MissingTags>Summary, Parameter, Returns, Value, AutoDocumentCtors, Namespace, TypeParameter, AutoDocumentDispose</MissingTags>
<ProjectSummary>MessagePack for CLI is interoperable serialization library for any CLI environments %28C#, VB, F#, etc. on CLR%28.NET%29, Mono, etc.%29.

Site: http://cli.msgpack.org/</ProjectSummary>
<VisibleItems>Attributes, InheritedMembers, Protected, SealedProtected</VisibleItems>
<DocumentationSources>
<DocumentationSource sourceFile="bin\net40-client\MsgPack.dll" xmlns="" />
<DocumentationSource sourceFile="bin\net40-client\MsgPack.XML" xmlns="" /></DocumentationSources>
<HelpFileFormat>HtmlHelp1, Website</HelpFileFormat>
<NamespaceSummaries>
<NamespaceSummaryItem name="MsgPack" isDocumented="True">&lt;para&gt;
&lt;c&gt;MsgPack&lt;/c&gt; namespace defines primitives of MessagePack for CLI.
&lt;/para&gt;
&lt;para&gt;
It includes &lt;see cref="T:MsgPack.MessagePackObject" /&gt; which is lightweight object representing MessagePack type system,
&lt;see cref="T:MsgPack.Packer" /&gt; which is packing primitive, and &lt;see cref="T:MsgPack.Unpacker" /&gt; which is unpacking primitive.
&lt;/para&gt;
&lt;para&gt;
Although you should usually use convinience &lt;see cref="N:MsgPack.Serialization" /&gt; APIs to serialize or deserialize object in MessagePack format,
you can use these primitives to control over serialization depending on internal state of the target object, etc.
&lt;/para&gt;</NamespaceSummaryItem>
<NamespaceSummaryItem name="MsgPack.Serialization" isDocumented="True">&lt;para&gt;
&lt;c&gt;MsgPack.Serialization&lt;/c&gt; namespace defines primitives of MessagePack for CLI.
&lt;/para&gt;
&lt;para&gt;
It includes a &lt;see cref="T:MsgPack.Serialization.MessagePackSerializer{T}" /&gt; class which is convinient serializer for any serializable object,
and its factory, a &lt;see cref="T:MsgPack.Serialization.MessagePackSerializer" /&gt; static class.
This namespace also includes &lt;see cref="T:MsgPack.Serialization.SerializationContext" /&gt;
which manages context information including serializer repository and configuration.
&lt;/para&gt;</NamespaceSummaryItem></NamespaceSummaries>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in
order for Visual Studio to perform the build. The others are optional
common platform types that may appear. -->
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
</PropertyGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
</Project>
93 changes: 93 additions & 0 deletions MsgPack.sl5.shfbproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
<PropertyGroup>
<!-- The configuration and platform will be used to determine which
assemblies to include from solution and project documentation
sources -->
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{928e44ef-1824-42ba-b6d2-01363b38ad6c}</ProjectGuid>
<SHFBSchemaVersion>1.9.3.0</SHFBSchemaVersion>
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
Studio adds them anyway -->
<AssemblyName>Documentation</AssemblyName>
<RootNamespace>Documentation</RootNamespace>
<Name>Documentation</Name>
<!-- SHFB properties -->
<OutputPath>.\Help.sl5\</OutputPath>
<HtmlHelpName>Documentation</HtmlHelpName>
<Language>en-US</Language>
<NamingMethod>MemberName</NamingMethod>
<Preliminary>True</Preliminary>
<PresentationStyle>vs2010</PresentationStyle>
<RootNamespaceContainer>True</RootNamespaceContainer>
<SdkLinkTarget>Self</SdkLinkTarget>
<SyntaxFilters>CSharp, VisualBasic</SyntaxFilters>
<ProductTitle>MessagePack for CLI</ProductTitle>
<VendorName>msgpack_org</VendorName>
<MissingTags>Summary, Parameter, Returns, Value, AutoDocumentCtors, Namespace, TypeParameter, AutoDocumentDispose</MissingTags>
<ProjectSummary>MessagePack for CLI is interoperable serialization library for any CLI environments %28C#, VB, F#, etc. on CLR%28.NET%29, Mono, etc.%29.

Site: http://cli.msgpack.org/</ProjectSummary>
<VisibleItems>Attributes, InheritedMembers, Protected, SealedProtected</VisibleItems>
<DocumentationSources>
<DocumentationSource sourceFile="bin\sl5\MsgPack.dll" />
<DocumentationSource sourceFile="bin\sl5\MsgPack.Serialization.dll" />
<DocumentationSource sourceFile="bin\sl5\MsgPack.Serialization.XML" />
<DocumentationSource sourceFile="bin\sl5\MsgPack.XML" /></DocumentationSources>
<HelpFileFormat>HtmlHelp1, Website</HelpFileFormat>
<FrameworkVersion>Silverlight 5.0</FrameworkVersion>
<NamespaceSummaries>
<NamespaceSummaryItem name="MsgPack" isDocumented="True" xmlns="">&lt;para&gt;
&lt;c&gt;MsgPack&lt;/c&gt; namespace defines primitives of MessagePack for CLI.
&lt;/para&gt;
&lt;para&gt;
It includes &lt;see cref="T:MsgPack.MessagePackObject" /&gt; which is lightweight object representing MessagePack type system,
&lt;see cref="T:MsgPack.Packer" /&gt; which is packing primitive, and &lt;see cref="T:MsgPack.Unpacker" /&gt; which is unpacking primitive.
&lt;/para&gt;
&lt;para&gt;
Although you should usually use convinience &lt;see cref="N:MsgPack.Serialization" /&gt; APIs to serialize or deserialize object in MessagePack format,
you can use these primitives to control over serialization depending on internal state of the target object, etc.
&lt;/para&gt;
&lt;note&gt;
You can reduce library binary size by including only a &lt;c&gt;MsgPack&lt;/c&gt; assembly.
When you chose this option, you can only use &lt;c&gt;MsgPack&lt;/c&gt; namespace APIs.
&lt;/note&gt;</NamespaceSummaryItem>
<NamespaceSummaryItem name="MsgPack.Serialization" isDocumented="True" xmlns="">&lt;para&gt;
&lt;c&gt;MsgPack.Serialization&lt;/c&gt; namespace defines primitives of MessagePack for CLI.
&lt;/para&gt;
&lt;para&gt;
It includes a &lt;see cref="T:MsgPack.Serialization.MessagePackSerializer{T}" /&gt; class which is convinient serializer for any serializable object,
and its factory, a &lt;see cref="T:MsgPack.Serialization.MessagePackSerializer" /&gt; static class.
This namespace also includes &lt;see cref="T:MsgPack.Serialization.SerializationContext" /&gt;
which manages context information including serializer repository and configuration.
&lt;/para&gt;</NamespaceSummaryItem></NamespaceSummaries>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in
order for Visual Studio to perform the build. The others are optional
common platform types that may appear. -->
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
</PropertyGroup>
<ItemGroup>
<Reference Include="System.Numerics">
<HintPath>bin\sl5\System.Numerics.dll</HintPath>
</Reference>
</ItemGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
</Project>

0 comments on commit 5108a94

Please sign in to comment.