/tools/nant/NAnt.CompressionTasks.xml

http://github.com/philiplaureano/LinFu · XML · 711 lines · 711 code · 0 blank · 0 comment · 0 complexity · 341e6b263daf6ab4886615c1026b32d6 MD5 · raw file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NAnt.CompressionTasks</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NAnt.Compression.Tasks.ExpandBaseTask">
  8. <summary>
  9. Summary description for ExpandTask.
  10. </summary>
  11. </member>
  12. <member name="M:NAnt.Compression.Tasks.ExpandBaseTask.ExtractFile(System.IO.Stream,System.String,System.String,System.DateTime,System.Int64)">
  13. <summary>
  14. Extracts a file entry from the specified stream.
  15. </summary>
  16. <param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the compressed entry.</param>
  17. <param name="destDirectory">The directory where to store the expanded file.</param>
  18. <param name="entryName">The name of the entry including directory information.</param>
  19. <param name="entryDate">The date of the entry.</param>
  20. <param name="entrySize">The uncompressed size of the entry.</param>
  21. <exception cref="T:NAnt.Core.BuildException">
  22. <para>The destination directory for the entry could not be created.</para>
  23. <para>-or-</para>
  24. <para>The entry could not be extracted.</para>
  25. </exception>
  26. <remarks>
  27. We cannot rely on the fact that the directory entry of a given file
  28. is created before the file is extracted, so we should create the
  29. directory if it doesn't yet exist.
  30. </remarks>
  31. </member>
  32. <member name="M:NAnt.Compression.Tasks.ExpandBaseTask.ExtractDirectory(System.IO.Stream,System.String,System.String,System.DateTime)">
  33. <summary>
  34. Extracts a directory entry from the specified stream.
  35. </summary>
  36. <param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the directory entry.</param>
  37. <param name="destDirectory">The directory where to create the subdirectory.</param>
  38. <param name="entryName">The name of the directory entry.</param>
  39. <param name="entryDate">The date of the entry.</param>
  40. <exception cref="T:NAnt.Core.BuildException">
  41. <para>The destination directory for the entry could not be created.</para>
  42. </exception>
  43. </member>
  44. <member name="P:NAnt.Compression.Tasks.ExpandBaseTask.Overwrite">
  45. <summary>
  46. Overwrite files, even if they are newer than the corresponding
  47. entries in the archive. The default is <see langword="true" />.
  48. </summary>
  49. </member>
  50. <member name="T:NAnt.Compression.Tasks.GUnzip">
  51. <summary>
  52. Expands a file packed using GZip compression.
  53. </summary>
  54. <example>
  55. <para>Expands &quot;test.tar.gz&quot; to &quot;test2.tar&quot;.</para>
  56. <code>
  57. <![CDATA[
  58. <gunzip src="test.tar.gz" dest="test.tar" />
  59. ]]>
  60. </code>
  61. </example>
  62. </member>
  63. <member name="M:NAnt.Compression.Tasks.GUnzip.ExecuteTask">
  64. <summary>
  65. Extracts the file from the gzip archive.
  66. </summary>
  67. </member>
  68. <member name="P:NAnt.Compression.Tasks.GUnzip.SrcFile">
  69. <summary>
  70. The file to expand.
  71. </summary>
  72. </member>
  73. <member name="P:NAnt.Compression.Tasks.GUnzip.DestFile">
  74. <summary>
  75. The destination file.
  76. </summary>
  77. </member>
  78. <member name="T:NAnt.Compression.Tasks.TarTask">
  79. <summary>
  80. Creates a tar file from the specified filesets.
  81. </summary>
  82. <remarks>
  83. <para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.</para>
  84. </remarks>
  85. <example>
  86. <para>
  87. Tar all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
  88. called &quot;backup.tar.gz&quot;, and apply gzip compression to it.
  89. </para>
  90. <code>
  91. <![CDATA[
  92. <tar destfile="backup.tar.gz" compression="GZip">
  93. <fileset basedir="${bin.dir}" prefix="bin">
  94. <include name="**/*" />
  95. </fileset>
  96. <fileset basedir="${doc.dir}" prefix="doc">
  97. <include name="**/*" />
  98. </fileset>
  99. </tar>
  100. ]]>
  101. </code>
  102. </example>
  103. </member>
  104. <member name="M:NAnt.Compression.Tasks.TarTask.ExecuteTask">
  105. <summary>
  106. Creates the tar file.
  107. </summary>
  108. </member>
  109. <member name="P:NAnt.Compression.Tasks.TarTask.DestFile">
  110. <summary>
  111. The tar file to create.
  112. </summary>
  113. </member>
  114. <member name="P:NAnt.Compression.Tasks.TarTask.IncludeEmptyDirs">
  115. <summary>
  116. Include empty directories in the generated tar file. The default is
  117. <see langword="false" />.
  118. </summary>
  119. </member>
  120. <member name="P:NAnt.Compression.Tasks.TarTask.TarFileSets">
  121. <summary>
  122. The set of files to be included in the archive.
  123. </summary>
  124. </member>
  125. <member name="P:NAnt.Compression.Tasks.TarTask.CompressionMethod">
  126. <summary>
  127. The compression method. The default is <see cref="F:NAnt.Compression.Types.TarCompressionMethod.None"/>.
  128. </summary>
  129. </member>
  130. <member name="T:NAnt.Compression.Tasks.UnTarTask">
  131. <summary>
  132. Extracts files from a tar archive.
  133. </summary>
  134. <remarks>
  135. <para>
  136. Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
  137. (SharpZipLib), an open source Zip/GZip library written entirely in C#.
  138. </para>
  139. </remarks>
  140. <example>
  141. <para>Extracts all files from a gzipped tar, preserving the directory structure.</para>
  142. <code>
  143. <![CDATA[
  144. <untar src="nant-bin.tar.gz" dest="bin" compression="gzip" />
  145. ]]>
  146. </code>
  147. </example>
  148. </member>
  149. <member name="M:NAnt.Compression.Tasks.UnTarTask.ExecuteTask">
  150. <summary>
  151. Extracts the files from the archive.
  152. </summary>
  153. </member>
  154. <member name="P:NAnt.Compression.Tasks.UnTarTask.SrcFile">
  155. <summary>
  156. The archive file to expand.
  157. </summary>
  158. </member>
  159. <member name="P:NAnt.Compression.Tasks.UnTarTask.DestinationDirectory">
  160. <summary>
  161. The directory where to store the expanded file(s). The default is
  162. the project base directory.
  163. </summary>
  164. </member>
  165. <member name="P:NAnt.Compression.Tasks.UnTarTask.CompressionMethod">
  166. <summary>
  167. The compression method. The default is <see cref="F:NAnt.Compression.Types.TarCompressionMethod.None"/>.
  168. </summary>
  169. </member>
  170. <member name="T:NAnt.Compression.Tasks.UnZipTask">
  171. <summary>
  172. Extracts files from a zip archive.
  173. </summary>
  174. <remarks>
  175. <para>
  176. Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
  177. (SharpZipLib), an open source Zip/GZip library written entirely in C#.
  178. </para>
  179. </remarks>
  180. <example>
  181. <para>Extracts all the file from the zip, preserving the directory structure.</para>
  182. <code>
  183. <![CDATA[
  184. <unzip zipfile="backup.zip"/>
  185. ]]>
  186. </code>
  187. </example>
  188. </member>
  189. <member name="M:NAnt.Compression.Tasks.UnZipTask.ExecuteTask">
  190. <summary>
  191. Extracts the files from the zip file.
  192. </summary>
  193. </member>
  194. <member name="P:NAnt.Compression.Tasks.UnZipTask.ZipFile">
  195. <summary>
  196. The archive file to expand.
  197. </summary>
  198. </member>
  199. <member name="P:NAnt.Compression.Tasks.UnZipTask.ToDirectory">
  200. <summary>
  201. The directory where the expanded files should be stored. The
  202. default is the project base directory.
  203. </summary>
  204. </member>
  205. <member name="P:NAnt.Compression.Tasks.UnZipTask.Encoding">
  206. <summary>
  207. The character encoding that has been used for filenames inside the
  208. zip file. The default is the system's OEM code page.
  209. </summary>
  210. </member>
  211. <member name="T:NAnt.Compression.Tasks.ZipTask">
  212. <summary>
  213. Creates a zip file from the specified filesets.
  214. </summary>
  215. <remarks>
  216. <para>
  217. Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
  218. (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.
  219. </para>
  220. </remarks>
  221. <example>
  222. <para>
  223. Zip all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
  224. called &quot;backup.zip&quot;.
  225. </para>
  226. <code>
  227. <![CDATA[
  228. <zip zipfile="backup.zip">
  229. <fileset basedir="${bin.dir}" prefix="bin">
  230. <include name="**/*" />
  231. </fileset>
  232. <fileset basedir="${doc.dir}" prefix="doc">
  233. <include name="**/*" />
  234. </fileset>
  235. </zip>
  236. ]]>
  237. </code>
  238. </example>
  239. </member>
  240. <member name="M:NAnt.Compression.Tasks.ZipTask.ExecuteTask">
  241. <summary>
  242. Creates the zip file.
  243. </summary>
  244. </member>
  245. <member name="P:NAnt.Compression.Tasks.ZipTask.ZipFile">
  246. <summary>
  247. The zip file to create.
  248. </summary>
  249. </member>
  250. <member name="P:NAnt.Compression.Tasks.ZipTask.Comment">
  251. <summary>
  252. The comment for the file.
  253. </summary>
  254. </member>
  255. <member name="P:NAnt.Compression.Tasks.ZipTask.Stamp">
  256. <summary>
  257. Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS.
  258. </summary>
  259. </member>
  260. <member name="P:NAnt.Compression.Tasks.ZipTask.ZipLevel">
  261. <summary>
  262. Desired level of compression. Possible values are 0 (STORE only)
  263. to 9 (highest). The default is <c>6</c>.
  264. </summary>
  265. </member>
  266. <member name="P:NAnt.Compression.Tasks.ZipTask.IncludeEmptyDirs">
  267. <summary>
  268. Include empty directories in the generated zip file. The default is
  269. <see langword="false" />.
  270. </summary>
  271. </member>
  272. <member name="P:NAnt.Compression.Tasks.ZipTask.ZipFileSets">
  273. <summary>
  274. The set of files to be included in the archive.
  275. </summary>
  276. </member>
  277. <member name="P:NAnt.Compression.Tasks.ZipTask.DuplicateHandling">
  278. <summary>
  279. Specifies the behaviour when a duplicate file is found. The default
  280. is <see cref="F:NAnt.Compression.Types.DuplicateHandling.Add"/>.
  281. </summary>
  282. </member>
  283. <member name="P:NAnt.Compression.Tasks.ZipTask.Encoding">
  284. <summary>
  285. The character encoding to use for filenames and comment inside the
  286. zip file. The default is the system's OEM code page.
  287. </summary>
  288. </member>
  289. <member name="T:NAnt.Compression.Types.DuplicateHandling">
  290. <summary>
  291. Specifies how entries with the same name should be processed.
  292. </summary>
  293. </member>
  294. <member name="F:NAnt.Compression.Types.DuplicateHandling.Add">
  295. <summary>
  296. Overwrite existing entry with same name.
  297. </summary>
  298. </member>
  299. <member name="F:NAnt.Compression.Types.DuplicateHandling.Preserve">
  300. <summary>
  301. Preserve existing entry with the same name.
  302. </summary>
  303. </member>
  304. <member name="F:NAnt.Compression.Types.DuplicateHandling.Fail">
  305. <summary>
  306. Report failure when two entries have the same name.
  307. </summary>
  308. </member>
  309. <member name="T:NAnt.Compression.Types.DuplicateHandlingConverter">
  310. <summary>
  311. Specialized <see cref="T:System.ComponentModel.EnumConverter"/> for <see cref="T:NAnt.Compression.Types.TarCompressionMethod"/>
  312. that ignores case when converting from string.
  313. </summary>
  314. </member>
  315. <member name="M:NAnt.Compression.Types.DuplicateHandlingConverter.#ctor">
  316. <summary>
  317. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.DuplicateHandlingConverter"/>
  318. class.
  319. </summary>
  320. </member>
  321. <member name="M:NAnt.Compression.Types.DuplicateHandlingConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
  322. <summary>
  323. Converts the given object to the type of this converter, using the
  324. specified context and culture information.
  325. </summary>
  326. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  327. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
  328. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  329. <returns>
  330. An <see cref="T:System.Object"/> that represents the converted value.
  331. </returns>
  332. </member>
  333. <member name="T:NAnt.Compression.Types.TarCompressionMethod">
  334. <summary>
  335. Specifies the compression methods supported by <see cref="T:NAnt.Compression.Tasks.TarTask"/>
  336. and <see cref="T:NAnt.Compression.Tasks.UnTarTask"/>.
  337. </summary>
  338. </member>
  339. <member name="F:NAnt.Compression.Types.TarCompressionMethod.None">
  340. <summary>
  341. No compression.
  342. </summary>
  343. </member>
  344. <member name="F:NAnt.Compression.Types.TarCompressionMethod.GZip">
  345. <summary>
  346. GZIP compression.
  347. </summary>
  348. </member>
  349. <member name="F:NAnt.Compression.Types.TarCompressionMethod.BZip2">
  350. <summary>
  351. BZIP2 compression.
  352. </summary>
  353. </member>
  354. <member name="T:NAnt.Compression.Types.TarCompressionMethodConverter">
  355. <summary>
  356. Specialized <see cref="T:System.ComponentModel.EnumConverter"/> for <see cref="T:NAnt.Compression.Types.TarCompressionMethod"/>
  357. that ignores case when converting from string.
  358. </summary>
  359. </member>
  360. <member name="M:NAnt.Compression.Types.TarCompressionMethodConverter.#ctor">
  361. <summary>
  362. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarCompressionMethodConverter"/>
  363. class.
  364. </summary>
  365. </member>
  366. <member name="M:NAnt.Compression.Types.TarCompressionMethodConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
  367. <summary>
  368. Converts the given object to the type of this converter, using the
  369. specified context and culture information.
  370. </summary>
  371. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  372. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
  373. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  374. <returns>
  375. An <see cref="T:System.Object"/> that represents the converted value.
  376. </returns>
  377. </member>
  378. <member name="T:NAnt.Compression.Types.TarFileSet">
  379. <summary>
  380. A <see cref="T:NAnt.Compression.Types.TarFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
  381. attributes useful in the context of the <see cref="T:NAnt.Compression.Tasks.TarTask"/>.
  382. </summary>
  383. </member>
  384. <member name="P:NAnt.Compression.Types.TarFileSet.FileMode">
  385. <summary>
  386. A 3 digit octal string, specify the user, group and other modes
  387. in the standard Unix fashion. Only applies to plain files. The
  388. default is <c>644</c>.
  389. </summary>
  390. </member>
  391. <member name="P:NAnt.Compression.Types.TarFileSet.DirMode">
  392. <summary>
  393. A 3 digit octal string, specify the user, group and other modes
  394. in the standard Unix fashion. Only applies to directories. The
  395. default is <c>755</c>.
  396. </summary>
  397. </member>
  398. <member name="P:NAnt.Compression.Types.TarFileSet.UserName">
  399. <summary>
  400. The username for the tar entry.
  401. </summary>
  402. </member>
  403. <member name="P:NAnt.Compression.Types.TarFileSet.Uid">
  404. <summary>
  405. The user identifier (UID) for the tar entry.
  406. </summary>
  407. </member>
  408. <member name="P:NAnt.Compression.Types.TarFileSet.GroupName">
  409. <summary>
  410. The groupname for the tar entry.
  411. </summary>
  412. </member>
  413. <member name="P:NAnt.Compression.Types.TarFileSet.Gid">
  414. <summary>
  415. The group identifier (GID) for the tar entry.
  416. </summary>
  417. </member>
  418. <member name="P:NAnt.Compression.Types.TarFileSet.Prefix">
  419. <summary>
  420. The top level directory prefix. If set, all file and directory paths
  421. in the fileset will have this value prepended. Can either be a single
  422. directory name or a "/" separated path.
  423. </summary>
  424. </member>
  425. <member name="T:NAnt.Compression.Types.TarFileSetCollection">
  426. <summary>
  427. Contains a collection of <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements.
  428. </summary>
  429. </member>
  430. <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor">
  431. <summary>
  432. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class.
  433. </summary>
  434. </member>
  435. <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor(NAnt.Compression.Types.TarFileSetCollection)">
  436. <summary>
  437. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class
  438. with the specified <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> instance.
  439. </summary>
  440. </member>
  441. <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor(NAnt.Compression.Types.TarFileSet[])">
  442. <summary>
  443. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class
  444. with the specified array of <see cref="T:NAnt.Compression.Types.TarFileSet"/> instances.
  445. </summary>
  446. </member>
  447. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Add(NAnt.Compression.Types.TarFileSet)">
  448. <summary>
  449. Adds a <see cref="T:NAnt.Compression.Types.TarFileSet"/> to the end of the collection.
  450. </summary>
  451. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to be added to the end of the collection.</param>
  452. <returns>The position into which the new element was inserted.</returns>
  453. </member>
  454. <member name="M:NAnt.Compression.Types.TarFileSetCollection.AddRange(NAnt.Compression.Types.TarFileSet[])">
  455. <summary>
  456. Adds the elements of a <see cref="T:NAnt.Compression.Types.TarFileSet"/> array to the end of the collection.
  457. </summary>
  458. <param name="items">The array of <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements to be added to the end of the collection.</param>
  459. </member>
  460. <member name="M:NAnt.Compression.Types.TarFileSetCollection.AddRange(NAnt.Compression.Types.TarFileSetCollection)">
  461. <summary>
  462. Adds the elements of a <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> to the end of the collection.
  463. </summary>
  464. <param name="items">The <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> to be added to the end of the collection.</param>
  465. </member>
  466. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Contains(NAnt.Compression.Types.TarFileSet)">
  467. <summary>
  468. Determines whether a <see cref="T:NAnt.Compression.Types.TarFileSet"/> is in the collection.
  469. </summary>
  470. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to locate in the collection.</param>
  471. <returns>
  472. <see langword="true"/> if <paramref name="item"/> is found in the
  473. collection; otherwise, <see langword="false"/>.
  474. </returns>
  475. </member>
  476. <member name="M:NAnt.Compression.Types.TarFileSetCollection.CopyTo(NAnt.Compression.Types.TarFileSet[],System.Int32)">
  477. <summary>
  478. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  479. </summary>
  480. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  481. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  482. </member>
  483. <member name="M:NAnt.Compression.Types.TarFileSetCollection.IndexOf(NAnt.Compression.Types.TarFileSet)">
  484. <summary>
  485. Retrieves the index of a specified <see cref="T:NAnt.Compression.Types.TarFileSet"/> object in the collection.
  486. </summary>
  487. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> object for which the index is returned.</param>
  488. <returns>
  489. The index of the specified <see cref="T:NAnt.Compression.Types.TarFileSet"/>. If the <see cref="T:NAnt.Compression.Types.TarFileSet"/> is not currently a member of the collection, it returns -1.
  490. </returns>
  491. </member>
  492. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Insert(System.Int32,NAnt.Compression.Types.TarFileSet)">
  493. <summary>
  494. Inserts a <see cref="T:NAnt.Compression.Types.TarFileSet"/> into the collection at the specified index.
  495. </summary>
  496. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  497. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to insert.</param>
  498. </member>
  499. <member name="M:NAnt.Compression.Types.TarFileSetCollection.GetEnumerator">
  500. <summary>
  501. Returns an enumerator that can iterate through the collection.
  502. </summary>
  503. <returns>
  504. A <see cref="T:NAnt.Compression.Types.TarFileSetEnumerator"/> for the entire collection.
  505. </returns>
  506. </member>
  507. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Remove(NAnt.Compression.Types.TarFileSet)">
  508. <summary>
  509. Removes a member from the collection.
  510. </summary>
  511. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to remove from the collection.</param>
  512. </member>
  513. <member name="P:NAnt.Compression.Types.TarFileSetCollection.Item(System.Int32)">
  514. <summary>
  515. Gets or sets the element at the specified index.
  516. </summary>
  517. <param name="index">The zero-based index of the element to get or set.</param>
  518. </member>
  519. <member name="P:NAnt.Compression.Types.TarFileSetCollection.FileCount">
  520. <summary>
  521. Get the total number of files that are represented by the
  522. filesets in this collection.
  523. </summary>
  524. </member>
  525. <member name="T:NAnt.Compression.Types.TarFileSetEnumerator">
  526. <summary>
  527. Enumerates the <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements of a <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/>.
  528. </summary>
  529. </member>
  530. <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.#ctor(NAnt.Compression.Types.TarFileSetCollection)">
  531. <summary>
  532. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetEnumerator"/> class
  533. with the specified <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/>.
  534. </summary>
  535. <param name="TarFileSets">The collection that should be enumerated.</param>
  536. </member>
  537. <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.MoveNext">
  538. <summary>
  539. Advances the enumerator to the next element of the collection.
  540. </summary>
  541. <returns>
  542. <see langword="true" /> if the enumerator was successfully advanced
  543. to the next element; <see langword="false" /> if the enumerator has
  544. passed the end of the collection.
  545. </returns>
  546. </member>
  547. <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.Reset">
  548. <summary>
  549. Sets the enumerator to its initial position, which is before the
  550. first element in the collection.
  551. </summary>
  552. </member>
  553. <member name="P:NAnt.Compression.Types.TarFileSetEnumerator.Current">
  554. <summary>
  555. Gets the current element in the collection.
  556. </summary>
  557. <returns>
  558. The current element in the collection.
  559. </returns>
  560. </member>
  561. <member name="T:NAnt.Compression.Types.ZipFileSet">
  562. <summary>
  563. A <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
  564. attributes useful in the context of the <see cref="T:NAnt.Compression.Tasks.ZipTask"/>.
  565. </summary>
  566. </member>
  567. <member name="P:NAnt.Compression.Types.ZipFileSet.Prefix">
  568. <summary>
  569. The top level directory prefix. If set, all file and directory paths
  570. in the fileset will have this value prepended. Can either be a single
  571. directory name or a "/" separated path.
  572. </summary>
  573. </member>
  574. <member name="T:NAnt.Compression.Types.ZipFileSetCollection">
  575. <summary>
  576. Contains a collection of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements.
  577. </summary>
  578. </member>
  579. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor">
  580. <summary>
  581. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class.
  582. </summary>
  583. </member>
  584. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor(NAnt.Compression.Types.ZipFileSetCollection)">
  585. <summary>
  586. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class
  587. with the specified <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> instance.
  588. </summary>
  589. </member>
  590. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor(NAnt.Compression.Types.ZipFileSet[])">
  591. <summary>
  592. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class
  593. with the specified array of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> instances.
  594. </summary>
  595. </member>
  596. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Add(NAnt.Compression.Types.ZipFileSet)">
  597. <summary>
  598. Adds a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to the end of the collection.
  599. </summary>
  600. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to be added to the end of the collection.</param>
  601. <returns>The position into which the new element was inserted.</returns>
  602. </member>
  603. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.AddRange(NAnt.Compression.Types.ZipFileSet[])">
  604. <summary>
  605. Adds the elements of a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> array to the end of the collection.
  606. </summary>
  607. <param name="items">The array of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements to be added to the end of the collection.</param>
  608. </member>
  609. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.AddRange(NAnt.Compression.Types.ZipFileSetCollection)">
  610. <summary>
  611. Adds the elements of a <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> to the end of the collection.
  612. </summary>
  613. <param name="items">The <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> to be added to the end of the collection.</param>
  614. </member>
  615. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Contains(NAnt.Compression.Types.ZipFileSet)">
  616. <summary>
  617. Determines whether a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is in the collection.
  618. </summary>
  619. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to locate in the collection.</param>
  620. <returns>
  621. <see langword="true"/> if <paramref name="item"/> is found in the
  622. collection; otherwise, <see langword="false"/>.
  623. </returns>
  624. </member>
  625. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.CopyTo(NAnt.Compression.Types.ZipFileSet[],System.Int32)">
  626. <summary>
  627. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  628. </summary>
  629. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  630. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  631. </member>
  632. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.IndexOf(NAnt.Compression.Types.ZipFileSet)">
  633. <summary>
  634. Retrieves the index of a specified <see cref="T:NAnt.Compression.Types.ZipFileSet"/> object in the collection.
  635. </summary>
  636. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> object for which the index is returned.</param>
  637. <returns>
  638. The index of the specified <see cref="T:NAnt.Compression.Types.ZipFileSet"/>. If the <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is not currently a member of the collection, it returns -1.
  639. </returns>
  640. </member>
  641. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Insert(System.Int32,NAnt.Compression.Types.ZipFileSet)">
  642. <summary>
  643. Inserts a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> into the collection at the specified index.
  644. </summary>
  645. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  646. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to insert.</param>
  647. </member>
  648. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.GetEnumerator">
  649. <summary>
  650. Returns an enumerator that can iterate through the collection.
  651. </summary>
  652. <returns>
  653. A <see cref="T:NAnt.Compression.Types.ZipFileSetEnumerator"/> for the entire collection.
  654. </returns>
  655. </member>
  656. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Remove(NAnt.Compression.Types.ZipFileSet)">
  657. <summary>
  658. Removes a member from the collection.
  659. </summary>
  660. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to remove from the collection.</param>
  661. </member>
  662. <member name="P:NAnt.Compression.Types.ZipFileSetCollection.Item(System.Int32)">
  663. <summary>
  664. Gets or sets the element at the specified index.
  665. </summary>
  666. <param name="index">The zero-based index of the element to get or set.</param>
  667. </member>
  668. <member name="P:NAnt.Compression.Types.ZipFileSetCollection.FileCount">
  669. <summary>
  670. Get the total number of files that are represented by the
  671. filesets in this collection.
  672. </summary>
  673. </member>
  674. <member name="T:NAnt.Compression.Types.ZipFileSetEnumerator">
  675. <summary>
  676. Enumerates the <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements of a <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/>.
  677. </summary>
  678. </member>
  679. <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.#ctor(NAnt.Compression.Types.ZipFileSetCollection)">
  680. <summary>
  681. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetEnumerator"/> class
  682. with the specified <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/>.
  683. </summary>
  684. <param name="ZipFileSets">The collection that should be enumerated.</param>
  685. </member>
  686. <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.MoveNext">
  687. <summary>
  688. Advances the enumerator to the next element of the collection.
  689. </summary>
  690. <returns>
  691. <see langword="true" /> if the enumerator was successfully advanced
  692. to the next element; <see langword="false" /> if the enumerator has
  693. passed the end of the collection.
  694. </returns>
  695. </member>
  696. <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.Reset">
  697. <summary>
  698. Sets the enumerator to its initial position, which is before the
  699. first element in the collection.
  700. </summary>
  701. </member>
  702. <member name="P:NAnt.Compression.Types.ZipFileSetEnumerator.Current">
  703. <summary>
  704. Gets the current element in the collection.
  705. </summary>
  706. <returns>
  707. The current element in the collection.
  708. </returns>
  709. </member>
  710. </members>
  711. </doc>