Skip to content

Commit c4b5012

Browse files
McNeightMcNeight
committed
Documentation, Part 1
* Migrate contents of ReadMe.rtf into README.md in root directory * Add more file format specifications and index * Upgrade SharpZipLib.shfb to SharpZipLib_VS2013.shfbproj and create SharpZipLib.chm * Include Code Map from VS2015 Enterprise
1 parent f72f50e commit c4b5012

17 files changed

Lines changed: 10359 additions & 2785 deletions

‎Documentation/CONTRIBUTING.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributing to SharpZipLib
2+
3+
Thanks for helping to improve SharpZipLib.
4+
5+
In order for your changes to be accepted you can either sign the [Joint Copyright Assignment](http://www.icsharpcode.net/TechNotes/JointCopyrightAssignment.pdf) or add the following statement to your pull request:
6+
7+
_I certify that I own, and have sufficient rights to contribute, all source code and related material intended to be compiled or integrated with the source code for the #ziplib open source product (the "Contribution"). My Contribution is licensed under the MIT License._
8+
9+
Unless we have a Joint Copyright Agreement on file or this statement is in your pull request, we cannot accept it.
10+
11+
More information is available on [joining the team](https://github.com/icsharpcode/SharpDevelop/wiki/Joining-the-Team).

‎Documentation/ReadMe.rtf‎

Lines changed: 0 additions & 99 deletions
This file was deleted.

‎Documentation/SharpZipLib.shfb‎

Lines changed: 0 additions & 55 deletions
This file was deleted.

‎Documentation/SharpZipLibCodeMap.dgml‎

Lines changed: 413 additions & 0 deletions
Large diffs are not rendered by default.

‎Documentation/SharpZipLib_MD.shfbproj‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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>{3b65ed0d-1572-45b4-ac3a-5dfb2ed3df74}</ProjectGuid>
10+
<SHFBSchemaVersion>2015.6.5.0</SHFBSchemaVersion>
11+
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
12+
<AssemblyName>Documentation</AssemblyName>
13+
<RootNamespace>Documentation</RootNamespace>
14+
<Name>Documentation</Name>
15+
<!-- SHFB properties -->
16+
<FrameworkVersion>.NET Framework 4.5</FrameworkVersion>
17+
<OutputPath>help_md\</OutputPath>
18+
<HtmlHelpName>SharpZipLib</HtmlHelpName>
19+
<Language>en-US</Language>
20+
<ProjectSummary>#ziplib compression library</ProjectSummary>
21+
<MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, Namespace, TypeParameter</MissingTags>
22+
<VisibleItems>InheritedMembers, InheritedFrameworkMembers, Protected, SealedProtected</VisibleItems>
23+
<HtmlHelp1xCompilerPath />
24+
<WorkingPath />
25+
<HelpTitle>ICSharpCode.SharpZipLib Compression Library</HelpTitle>
26+
<PresentationStyle>Markdown</PresentationStyle>
27+
<DocumentationSources>
28+
<DocumentationSource sourceFile="..\bin\ICSharpCode.SharpZipLib.dll" />
29+
<DocumentationSource sourceFile="..\bin\ICSharpCode.SharpZipLib.XML" />
30+
</DocumentationSources>
31+
<NamespaceSummaries>
32+
<NamespaceSummaryItem name="(global)" isDocumented="False" xmlns="" />
33+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib" isDocumented="True" xmlns="">The root namespace for this library.</NamespaceSummaryItem>
34+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.BZip2" isDocumented="True" xmlns="">BZip2 compression handling</NamespaceSummaryItem>
35+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Checksums" isDocumented="True" xmlns="">Checksum Handling</NamespaceSummaryItem>
36+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Core" isDocumented="True" xmlns="">Core Utilities</NamespaceSummaryItem>
37+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Encryption" isDocumented="True" xmlns="">Encryption handling</NamespaceSummaryItem>
38+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.GZip" isDocumented="True" xmlns="">GZip compression handling</NamespaceSummaryItem>
39+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Tar" isDocumented="True" xmlns="">Tape Archive handling</NamespaceSummaryItem>
40+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Zip" isDocumented="True" xmlns="">ZIP archive handling</NamespaceSummaryItem>
41+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Zip.Compression" isDocumented="True" xmlns="">Zip Compression handling</NamespaceSummaryItem>
42+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Zip.Compression.Streams" isDocumented="True" xmlns="">Zip compression streams.</NamespaceSummaryItem>
43+
</NamespaceSummaries>
44+
<BuildAssemblerVerbosity>AllMessages</BuildAssemblerVerbosity>
45+
<BuildLogFile>SHFB_Build.log</BuildLogFile>
46+
<HelpFileFormat>Markdown</HelpFileFormat>
47+
<IndentHtml>False</IndentHtml>
48+
<KeepLogFile>True</KeepLogFile>
49+
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
50+
<CleanIntermediates>True</CleanIntermediates>
51+
<HelpFileVersion>1.0.0.0</HelpFileVersion>
52+
<MaximumGroupParts>2</MaximumGroupParts>
53+
<NamespaceGrouping>False</NamespaceGrouping>
54+
<SyntaxFilters>Standard</SyntaxFilters>
55+
<SdkLinkTarget>Blank</SdkLinkTarget>
56+
<RootNamespaceContainer>False</RootNamespaceContainer>
57+
<Preliminary>False</Preliminary>
58+
<NamingMethod>HashedMemberName</NamingMethod>
59+
<ContentPlacement>AboveNamespaces</ContentPlacement>
60+
</PropertyGroup>
61+
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
62+
the build. The others are optional common platform types that may appear. -->
63+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
64+
</PropertyGroup>
65+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
66+
</PropertyGroup>
67+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
68+
</PropertyGroup>
69+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
70+
</PropertyGroup>
71+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
72+
</PropertyGroup>
73+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
74+
</PropertyGroup>
75+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
76+
</PropertyGroup>
77+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
78+
</PropertyGroup>
79+
<!-- Import the SHFB build targets -->
80+
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
81+
</Project>

‎Documentation/SharpZipLib_VS2013.shfbproj‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
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>{3b65ed0d-1572-45b4-ac3a-5dfb2ed3df74}</ProjectGuid>
10+
<SHFBSchemaVersion>2015.6.5.0</SHFBSchemaVersion>
11+
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
12+
<AssemblyName>Documentation</AssemblyName>
13+
<RootNamespace>Documentation</RootNamespace>
14+
<Name>Documentation</Name>
15+
<!-- SHFB properties -->
16+
<FrameworkVersion>.NET Framework 4.5</FrameworkVersion>
17+
<OutputPath>.\help\</OutputPath>
18+
<HtmlHelpName>SharpZipLib</HtmlHelpName>
19+
<Language>en-US</Language>
20+
<ProjectSummary>#ziplib compression library</ProjectSummary>
21+
<MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, Namespace, TypeParameter</MissingTags>
22+
<VisibleItems>InheritedMembers, InheritedFrameworkMembers, Protected, SealedProtected</VisibleItems>
23+
<HtmlHelp1xCompilerPath />
24+
<WorkingPath />
25+
<HelpTitle>ICSharpCode.SharpZipLib Compression Library</HelpTitle>
26+
<PresentationStyle>VS2013</PresentationStyle>
27+
<DocumentationSources>
28+
<DocumentationSource sourceFile="..\bin\ICSharpCode.SharpZipLib.dll" />
29+
<DocumentationSource sourceFile="..\bin\ICSharpCode.SharpZipLib.XML" />
30+
</DocumentationSources>
31+
<NamespaceSummaries>
32+
<NamespaceSummaryItem name="(global)" isDocumented="False" xmlns="" />
33+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib" isDocumented="True" xmlns="">The root namespace for this library.</NamespaceSummaryItem>
34+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.BZip2" isDocumented="True" xmlns="">BZip2 compression handling</NamespaceSummaryItem>
35+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Checksums" isDocumented="True" xmlns="">Checksum Handling</NamespaceSummaryItem>
36+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Core" isDocumented="True" xmlns="">Core Utilities</NamespaceSummaryItem>
37+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Encryption" isDocumented="True" xmlns="">Encryption handling</NamespaceSummaryItem>
38+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.GZip" isDocumented="True" xmlns="">GZip compression handling</NamespaceSummaryItem>
39+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Tar" isDocumented="True" xmlns="">Tape Archive handling</NamespaceSummaryItem>
40+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Zip" isDocumented="True" xmlns="">ZIP archive handling</NamespaceSummaryItem>
41+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Zip.Compression" isDocumented="True" xmlns="">Zip Compression handling</NamespaceSummaryItem>
42+
<NamespaceSummaryItem name="ICSharpCode.SharpZipLib.Zip.Compression.Streams" isDocumented="True" xmlns="">Zip compression streams.</NamespaceSummaryItem>
43+
</NamespaceSummaries>
44+
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
45+
<BuildLogFile>SHFB_Build.log</BuildLogFile>
46+
<HelpFileFormat>HtmlHelp1, MSHelpViewer, Website</HelpFileFormat>
47+
<IndentHtml>False</IndentHtml>
48+
<KeepLogFile>True</KeepLogFile>
49+
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
50+
<CleanIntermediates>True</CleanIntermediates>
51+
</PropertyGroup>
52+
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
53+
the build. The others are optional common platform types that may appear. -->
54+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
55+
</PropertyGroup>
56+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
57+
</PropertyGroup>
58+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
59+
</PropertyGroup>
60+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
61+
</PropertyGroup>
62+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
63+
</PropertyGroup>
64+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
65+
</PropertyGroup>
66+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
67+
</PropertyGroup>
68+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
69+
</PropertyGroup>
70+
<!-- Import the SHFB build targets -->
71+
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
72+
</Project>

0 commit comments

Comments
 (0)