Skip to content

Commit 71164e5

Browse files
christophwillechristophwille
committed
Help building instructions (intentionally atm not checking in api/*.yml)
1 parent a4bec6f commit 71164e5

2 files changed

Lines changed: 263 additions & 2 deletions

File tree

‎docs/help/BuildingHelpInfo.txt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Basics
2+
3+
You need DocFx:
4+
5+
https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool
6+
7+
You have to run it using the "Developer Command Prompt for VS 2017"
8+
9+
10+
# Building
11+
12+
In this folder, run "docfx metadata" to build the API documentation (/api folder)
13+
14+
In this folder, run "serve.bat" to build & serve the documenation for local testing
15+
16+
17+
# Publishing
18+
19+
The _site folder is to be copied to gh-pages branch for publishing

‎docs/help/api/toc.yml‎

Lines changed: 244 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,244 @@
1-
- name: TO BE REPLACED
2-
- href: index.md
1+
### YamlMime:TableOfContent
2+
- uid: ICSharpCode.SharpZipLib
3+
name: ICSharpCode.SharpZipLib
4+
items:
5+
- uid: ICSharpCode.SharpZipLib.SharpZipBaseException
6+
name: SharpZipBaseException
7+
- uid: ICSharpCode.SharpZipLib.BZip2
8+
name: ICSharpCode.SharpZipLib.BZip2
9+
items:
10+
- uid: ICSharpCode.SharpZipLib.BZip2.BZip2
11+
name: BZip2
12+
- uid: ICSharpCode.SharpZipLib.BZip2.BZip2Exception
13+
name: BZip2Exception
14+
- uid: ICSharpCode.SharpZipLib.BZip2.BZip2InputStream
15+
name: BZip2InputStream
16+
- uid: ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream
17+
name: BZip2OutputStream
18+
- uid: ICSharpCode.SharpZipLib.Checksum
19+
name: ICSharpCode.SharpZipLib.Checksum
20+
items:
21+
- uid: ICSharpCode.SharpZipLib.Checksum.Adler32
22+
name: Adler32
23+
- uid: ICSharpCode.SharpZipLib.Checksum.BZip2Crc
24+
name: BZip2Crc
25+
- uid: ICSharpCode.SharpZipLib.Checksum.Crc32
26+
name: Crc32
27+
- uid: ICSharpCode.SharpZipLib.Checksum.IChecksum
28+
name: IChecksum
29+
- uid: ICSharpCode.SharpZipLib.Core
30+
name: ICSharpCode.SharpZipLib.Core
31+
items:
32+
- uid: ICSharpCode.SharpZipLib.Core.CompletedFileHandler
33+
name: CompletedFileHandler
34+
- uid: ICSharpCode.SharpZipLib.Core.DirectoryEventArgs
35+
name: DirectoryEventArgs
36+
- uid: ICSharpCode.SharpZipLib.Core.DirectoryFailureHandler
37+
name: DirectoryFailureHandler
38+
- uid: ICSharpCode.SharpZipLib.Core.ExtendedPathFilter
39+
name: ExtendedPathFilter
40+
- uid: ICSharpCode.SharpZipLib.Core.FileFailureHandler
41+
name: FileFailureHandler
42+
- uid: ICSharpCode.SharpZipLib.Core.FileSystemScanner
43+
name: FileSystemScanner
44+
- uid: ICSharpCode.SharpZipLib.Core.INameTransform
45+
name: INameTransform
46+
- uid: ICSharpCode.SharpZipLib.Core.IScanFilter
47+
name: IScanFilter
48+
- uid: ICSharpCode.SharpZipLib.Core.NameAndSizeFilter
49+
name: NameAndSizeFilter
50+
- uid: ICSharpCode.SharpZipLib.Core.NameFilter
51+
name: NameFilter
52+
- uid: ICSharpCode.SharpZipLib.Core.PathFilter
53+
name: PathFilter
54+
- uid: ICSharpCode.SharpZipLib.Core.ProcessFileHandler
55+
name: ProcessFileHandler
56+
- uid: ICSharpCode.SharpZipLib.Core.ProgressEventArgs
57+
name: ProgressEventArgs
58+
- uid: ICSharpCode.SharpZipLib.Core.ProgressHandler
59+
name: ProgressHandler
60+
- uid: ICSharpCode.SharpZipLib.Core.ScanEventArgs
61+
name: ScanEventArgs
62+
- uid: ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs
63+
name: ScanFailureEventArgs
64+
- uid: ICSharpCode.SharpZipLib.Core.StreamUtils
65+
name: StreamUtils
66+
- uid: ICSharpCode.SharpZipLib.Core.WindowsPathUtils
67+
name: WindowsPathUtils
68+
- uid: ICSharpCode.SharpZipLib.Encryption
69+
name: ICSharpCode.SharpZipLib.Encryption
70+
items:
71+
- uid: ICSharpCode.SharpZipLib.Encryption.PkzipClassic
72+
name: PkzipClassic
73+
- uid: ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged
74+
name: PkzipClassicManaged
75+
- uid: ICSharpCode.SharpZipLib.GZip
76+
name: ICSharpCode.SharpZipLib.GZip
77+
items:
78+
- uid: ICSharpCode.SharpZipLib.GZip.GZip
79+
name: GZip
80+
- uid: ICSharpCode.SharpZipLib.GZip.GZipConstants
81+
name: GZipConstants
82+
- uid: ICSharpCode.SharpZipLib.GZip.GZipException
83+
name: GZipException
84+
- uid: ICSharpCode.SharpZipLib.GZip.GZipInputStream
85+
name: GZipInputStream
86+
- uid: ICSharpCode.SharpZipLib.GZip.GZipOutputStream
87+
name: GZipOutputStream
88+
- uid: ICSharpCode.SharpZipLib.Lzw
89+
name: ICSharpCode.SharpZipLib.Lzw
90+
items:
91+
- uid: ICSharpCode.SharpZipLib.Lzw.LzwConstants
92+
name: LzwConstants
93+
- uid: ICSharpCode.SharpZipLib.Lzw.LzwException
94+
name: LzwException
95+
- uid: ICSharpCode.SharpZipLib.Lzw.LzwInputStream
96+
name: LzwInputStream
97+
- uid: ICSharpCode.SharpZipLib.Tar
98+
name: ICSharpCode.SharpZipLib.Tar
99+
items:
100+
- uid: ICSharpCode.SharpZipLib.Tar.InvalidHeaderException
101+
name: InvalidHeaderException
102+
- uid: ICSharpCode.SharpZipLib.Tar.ProgressMessageHandler
103+
name: ProgressMessageHandler
104+
- uid: ICSharpCode.SharpZipLib.Tar.TarArchive
105+
name: TarArchive
106+
- uid: ICSharpCode.SharpZipLib.Tar.TarBuffer
107+
name: TarBuffer
108+
- uid: ICSharpCode.SharpZipLib.Tar.TarEntry
109+
name: TarEntry
110+
- uid: ICSharpCode.SharpZipLib.Tar.TarException
111+
name: TarException
112+
- uid: ICSharpCode.SharpZipLib.Tar.TarHeader
113+
name: TarHeader
114+
- uid: ICSharpCode.SharpZipLib.Tar.TarInputStream
115+
name: TarInputStream
116+
- uid: ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter
117+
name: TarInputStream.EntryFactoryAdapter
118+
- uid: ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory
119+
name: TarInputStream.IEntryFactory
120+
- uid: ICSharpCode.SharpZipLib.Tar.TarOutputStream
121+
name: TarOutputStream
122+
- uid: ICSharpCode.SharpZipLib.Zip
123+
name: ICSharpCode.SharpZipLib.Zip
124+
items:
125+
- uid: ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage
126+
name: BaseArchiveStorage
127+
- uid: ICSharpCode.SharpZipLib.Zip.CompressionMethod
128+
name: CompressionMethod
129+
- uid: ICSharpCode.SharpZipLib.Zip.DescriptorData
130+
name: DescriptorData
131+
- uid: ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage
132+
name: DiskArchiveStorage
133+
- uid: ICSharpCode.SharpZipLib.Zip.DynamicDiskDataSource
134+
name: DynamicDiskDataSource
135+
- uid: ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm
136+
name: EncryptionAlgorithm
137+
- uid: ICSharpCode.SharpZipLib.Zip.ExtendedUnixData
138+
name: ExtendedUnixData
139+
- uid: ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags
140+
name: ExtendedUnixData.Flags
141+
- uid: ICSharpCode.SharpZipLib.Zip.FastZip
142+
name: FastZip
143+
- uid: ICSharpCode.SharpZipLib.Zip.FastZip.ConfirmOverwriteDelegate
144+
name: FastZip.ConfirmOverwriteDelegate
145+
- uid: ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite
146+
name: FastZip.Overwrite
147+
- uid: ICSharpCode.SharpZipLib.Zip.FastZipEvents
148+
name: FastZipEvents
149+
- uid: ICSharpCode.SharpZipLib.Zip.FileUpdateMode
150+
name: FileUpdateMode
151+
- uid: ICSharpCode.SharpZipLib.Zip.GeneralBitFlags
152+
name: GeneralBitFlags
153+
- uid: ICSharpCode.SharpZipLib.Zip.HostSystemID
154+
name: HostSystemID
155+
- uid: ICSharpCode.SharpZipLib.Zip.IArchiveStorage
156+
name: IArchiveStorage
157+
- uid: ICSharpCode.SharpZipLib.Zip.IDynamicDataSource
158+
name: IDynamicDataSource
159+
- uid: ICSharpCode.SharpZipLib.Zip.IEntryFactory
160+
name: IEntryFactory
161+
- uid: ICSharpCode.SharpZipLib.Zip.IStaticDataSource
162+
name: IStaticDataSource
163+
- uid: ICSharpCode.SharpZipLib.Zip.ITaggedData
164+
name: ITaggedData
165+
- uid: ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs
166+
name: KeysRequiredEventArgs
167+
- uid: ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage
168+
name: MemoryArchiveStorage
169+
- uid: ICSharpCode.SharpZipLib.Zip.NTTaggedData
170+
name: NTTaggedData
171+
- uid: ICSharpCode.SharpZipLib.Zip.RawTaggedData
172+
name: RawTaggedData
173+
- uid: ICSharpCode.SharpZipLib.Zip.StaticDiskDataSource
174+
name: StaticDiskDataSource
175+
- uid: ICSharpCode.SharpZipLib.Zip.TestOperation
176+
name: TestOperation
177+
- uid: ICSharpCode.SharpZipLib.Zip.TestStatus
178+
name: TestStatus
179+
- uid: ICSharpCode.SharpZipLib.Zip.TestStrategy
180+
name: TestStrategy
181+
- uid: ICSharpCode.SharpZipLib.Zip.UseZip64
182+
name: UseZip64
183+
- uid: ICSharpCode.SharpZipLib.Zip.WindowsNameTransform
184+
name: WindowsNameTransform
185+
- uid: ICSharpCode.SharpZipLib.Zip.ZipConstants
186+
name: ZipConstants
187+
- uid: ICSharpCode.SharpZipLib.Zip.ZipEntry
188+
name: ZipEntry
189+
- uid: ICSharpCode.SharpZipLib.Zip.ZipEntryFactory
190+
name: ZipEntryFactory
191+
- uid: ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting
192+
name: ZipEntryFactory.TimeSetting
193+
- uid: ICSharpCode.SharpZipLib.Zip.ZipException
194+
name: ZipException
195+
- uid: ICSharpCode.SharpZipLib.Zip.ZipExtraData
196+
name: ZipExtraData
197+
- uid: ICSharpCode.SharpZipLib.Zip.ZipFile
198+
name: ZipFile
199+
- uid: ICSharpCode.SharpZipLib.Zip.ZipFile.KeysRequiredEventHandler
200+
name: ZipFile.KeysRequiredEventHandler
201+
- uid: ICSharpCode.SharpZipLib.Zip.ZipInputStream
202+
name: ZipInputStream
203+
- uid: ICSharpCode.SharpZipLib.Zip.ZipNameTransform
204+
name: ZipNameTransform
205+
- uid: ICSharpCode.SharpZipLib.Zip.ZipOutputStream
206+
name: ZipOutputStream
207+
- uid: ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler
208+
name: ZipTestResultHandler
209+
- uid: ICSharpCode.SharpZipLib.Zip.Compression
210+
name: ICSharpCode.SharpZipLib.Zip.Compression
211+
items:
212+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Deflater
213+
name: Deflater
214+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel
215+
name: Deflater.CompressionLevel
216+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants
217+
name: DeflaterConstants
218+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine
219+
name: DeflaterEngine
220+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman
221+
name: DeflaterHuffman
222+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending
223+
name: DeflaterPending
224+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy
225+
name: DeflateStrategy
226+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Inflater
227+
name: Inflater
228+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree
229+
name: InflaterHuffmanTree
230+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer
231+
name: PendingBuffer
232+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Streams
233+
name: ICSharpCode.SharpZipLib.Zip.Compression.Streams
234+
items:
235+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream
236+
name: DeflaterOutputStream
237+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer
238+
name: InflaterInputBuffer
239+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream
240+
name: InflaterInputStream
241+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow
242+
name: OutputWindow
243+
- uid: ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator
244+
name: StreamManipulator

0 commit comments

Comments
 (0)