Skip to content

Commit f070034

Browse files
jfreillyjfreilly
committed
Summary comment cleanup
1 parent 1cdcdf5 commit f070034

File tree

12 files changed

+39
-21
lines changed

12 files changed

+39
-21
lines changed

‎src/BZip2/BZip2.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ public sealed class BZip2
5050
/// </summary>
5151
/// <param name="inStream">The stream containing data to decompress.</param>
5252
/// <param name="outStream">The stream to write decompressed data to.</param>
53+
/// <remarks>Both streams are closed on completion</remarks>
5354
public static void Decompress(Stream inStream, Stream outStream)
5455
{
5556
if ( inStream == null ) {
@@ -78,6 +79,7 @@ public static void Decompress(Stream inStream, Stream outStream)
7879
/// <param name="inStream">The stream to compress.</param>
7980
/// <param name="outStream">The stream to write compressed data to.</param>
8081
/// <param name="blockSize">The block size to use.</param>
82+
/// <remarks>Both streams are closed on completion</remarks>
8183
public static void Compress(Stream inStream, Stream outStream, int blockSize)
8284
{
8385
if ( inStream == null ) {

‎src/BZip2/BZip2InputStream.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ public override void Flush()
155155
/// <summary>
156156
/// Set the streams position. This operation is not supported and will throw a NotSupportedException
157157
/// </summary>
158+
/// <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
159+
/// <param name="origin">A value of type <see cref="SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
158160
/// <exception cref="NotSupportedException">Any access</exception>
159161
public override long Seek(long offset, SeekOrigin origin)
160162
{
@@ -165,6 +167,7 @@ public override long Seek(long offset, SeekOrigin origin)
165167
/// Sets the length of this stream to the given value.
166168
/// This operation is not supported and will throw a NotSupportedExceptionortedException
167169
/// </summary>
170+
/// <param name="value">The new length for the stream.</param>
168171
/// <exception cref="NotSupportedException">Any access</exception>
169172
public override void SetLength(long value)
170173
{
@@ -175,6 +178,9 @@ public override void SetLength(long value)
175178
/// Writes a block of bytes to this stream using data from a buffer.
176179
/// This operation is not supported and will throw a NotSupportedException
177180
/// </summary>
181+
/// <param name="buffer">The buffer to source data from.</param>
182+
/// <param name="offset">The offset to start obtaining data from.</param>
183+
/// <param name="count">The number of bytes of data to write.</param>
178184
/// <exception cref="NotSupportedException">Any access</exception>
179185
public override void Write(byte[] buffer, int offset, int count)
180186
{

‎src/Checksums/StrangeCRC.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ public void Update(int value)
154154

155155
/// <summary>
156156
/// Update Crc based on a block of data
157-
/// </summary>
157+
/// </summary>
158+
/// <param name="buffer">The buffer containing data to update the crc with.</param>
158159
public void Update(byte[] buffer)
159160
{
160161
if (buffer == null) {

‎src/Core/FileSystemScanner.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ public class ScanEventArgs : EventArgs
4949
/// <summary>
5050
/// Initialise a new instance of <see cref="ScanEventArgs"/>
5151
/// </summary>
52-
/// <param name="name"></param>
52+
/// <param name="name">The file or directory name.</param>
5353
public ScanEventArgs(string name)
5454
{
5555
name_ = name;
5656
}
5757
#endregion
5858

5959
/// <summary>
60-
/// The name for this event.
60+
/// The fie or directory name for this event.
6161
/// </summary>
6262
public string Name
6363
{
@@ -305,7 +305,7 @@ public FileSystemScanner(string filter)
305305
/// Initialise a new instance of <see cref="FileSystemScanner"></see>
306306
/// </summary>
307307
/// <param name="fileFilter">The <see cref="PathFilter">file filter</see> to apply.</param>
308-
/// <param name="directoryFilter">The <see cref="PathFilter">directory filter</see> to apply.</param>
308+
/// <param name="directoryFilter">The <see cref="PathFilter"> directory filter</see> to apply.</param>
309309
public FileSystemScanner(string fileFilter, string directoryFilter)
310310
{
311311
fileFilter_ = new PathFilter(fileFilter);
@@ -315,7 +315,7 @@ public FileSystemScanner(string fileFilter, string directoryFilter)
315315
/// <summary>
316316
/// Initialise a new instance of <see cref="FileSystemScanner"></see>
317317
/// </summary>
318-
/// <param name="fileFilter">The file <see cref="IScanFilter"></see>filter to apply.</param>
318+
/// <param name="fileFilter">The file <see cref="IScanFilter">filter</see> to apply.</param>
319319
public FileSystemScanner(IScanFilter fileFilter)
320320
{
321321
fileFilter_ = fileFilter;
@@ -324,8 +324,8 @@ public FileSystemScanner(IScanFilter fileFilter)
324324
/// <summary>
325325
/// Initialise a new instance of <see cref="FileSystemScanner"></see>
326326
/// </summary>
327-
/// <param name="fileFilter">The file <see cref="IScanFilter"></see>filter to apply.</param>
328-
/// <param name="directoryFilter">The directory <see cref="IScanFilter"></see>filter to apply.</param>
327+
/// <param name="fileFilter">The file <see cref="IScanFilter">filter</see> to apply.</param>
328+
/// <param name="directoryFilter">The directory <see cref="IScanFilter">filter</see> to apply.</param>
329329
public FileSystemScanner(IScanFilter fileFilter, IScanFilter directoryFilter)
330330
{
331331
fileFilter_ = fileFilter;

‎src/Core/PathFilter.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public class PathFilter : IScanFilter
4949
/// <summary>
5050
/// Initialise a new instance of <see cref="PathFilter"></see>.
5151
/// </summary>
52-
/// <param name="filter">The <see cref="NameFilter"></see>filter expression to apply.</param>
52+
/// <param name="filter">The <see cref="NameFilter">filter</see> expression to apply.</param>
5353
public PathFilter(string filter)
5454
{
5555
nameFilter_ = new NameFilter(filter);

‎src/Core/StreamUtils.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,10 @@ static public void ReadFully(Stream stream, byte[] buffer, int offset, int count
9595
/// <param name="source">The stream to source data from.</param>
9696
/// <param name="destination">The stream to write data to.</param>
9797
/// <param name="buffer">The buffer to use during copying.</param>
98-
/// <param name="progressHandler"></param>
99-
/// <param name="updateInterval"></param>
100-
/// <param name="sender"></param>
101-
/// <param name="name"></param>
98+
/// <param name="progressHandler">The <see cref="ProgressHandler">progress handler delegate</see> to use.</param>
99+
/// <param name="updateInterval">The minimum <see cref="TimeSpan"/> between progress updates.</param>
100+
/// <param name="sender">The source for this event.</param>
101+
/// <param name="name">The name to use with the event.</param>
102102
static public void Copy(Stream source, Stream destination,
103103
byte[] buffer, ProgressHandler progressHandler, TimeSpan updateInterval, object sender, string name)
104104
{

‎src/Encryption/PkzipClassic.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ public abstract class PkzipClassic : SymmetricAlgorithm
5454
/// <summary>
5555
/// Generates new encryption keys based on given seed
5656
/// </summary>
57+
/// <param name="seed">The seed value to initialise keys with.</param>
5758
static public byte[] GenerateKeys(byte[] seed)
5859
{
5960
if ( seed == null )

‎src/GZip/GzipInputStream.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ public GZipInputStream(Stream baseInputStream, int size)
130130
/// <param name="count">
131131
/// The number of uncompressed bytes to be read
132132
/// </param>
133+
/// <returns>Returns the number of bytes actually read.</returns>
133134
public override int Read(byte[] buffer, int offset, int count)
134135
{
135136
// We first have to read the GZIP header, then we feed all the

‎src/GZip/GzipOutputStream.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ public GZipOutputStream(Stream baseOutputStream) : this(baseOutputStream, 4096)
114114
/// Sets the active compression level (1-9). The new level will be activated
115115
/// immediately.
116116
/// </summary>
117+
/// <param name="level">The compression level to set.</param>
117118
/// <exception cref="ArgumentOutOfRangeException">
118119
/// Level specified is not supported.
119120
/// </exception>

‎src/Tar/TarArchive.cs‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public class TarArchive : IDisposable
7575
/// <summary>
7676
/// Raises the ProgressMessage event
7777
/// </summary>
78-
/// <param name="entry">TarEntry for this event</param>
78+
/// <param name="entry">The <see cref="TarEntry">TarEntry</see> for this event</param>
7979
/// <param name="message">message for this event. Null is no message</param>
8080
protected virtual void OnProgressMessageEvent(TarEntry entry, string message)
8181
{
@@ -126,6 +126,8 @@ protected TarArchive(TarOutputStream stream)
126126
/// these constructors when you wish to extract files from or list
127127
/// the contents of an existing tar archive.
128128
/// </summary>
129+
/// <param name="inputStream">The stream to retrieve archive data from.</param>
130+
/// <returns>Returns a new <see cref="TarArchive"/> suitable for reading from.</returns>
129131
public static TarArchive CreateInputTarArchive(Stream inputStream)
130132
{
131133
if ( inputStream == null ) {
@@ -140,9 +142,7 @@ public static TarArchive CreateInputTarArchive(Stream inputStream)
140142
/// </summary>
141143
/// <param name="inputStream">Stream for tar archive contents</param>
142144
/// <param name="blockFactor">The blocking factor to apply</param>
143-
/// <returns>
144-
/// TarArchive
145-
/// </returns>
145+
/// <returns>Returns a <see cref="TarArchive"/> suitable for reading.</returns>
146146
public static TarArchive CreateInputTarArchive(Stream inputStream, int blockFactor)
147147
{
148148
if ( inputStream == null ) {
@@ -155,7 +155,8 @@ public static TarArchive CreateInputTarArchive(Stream inputStream, int blockFact
155155
/// <summary>
156156
/// Create a TarArchive for writing to, using the default blocking factor
157157
/// </summary>
158-
/// <param name="outputStream">Stream to write to</param>
158+
/// <param name="outputStream">The <see cref="Stream"/> to write to</param>
159+
/// <returns>Returns a <see cref="TarArchive"/> suitable for writing.</returns>
159160
public static TarArchive CreateOutputTarArchive(Stream outputStream)
160161
{
161162
if ( outputStream == null ) {
@@ -170,6 +171,7 @@ public static TarArchive CreateOutputTarArchive(Stream outputStream)
170171
/// </summary>
171172
/// <param name="outputStream">The stream to write to</param>
172173
/// <param name="blockFactor">The blocking factor to use for buffering.</param>
174+
/// <returns>Returns a <see cref="TarArchive"/> suitable for writing.</returns>
173175
public static TarArchive CreateOutputTarArchive(Stream outputStream, int blockFactor)
174176
{
175177
if ( outputStream == null ) {

0 commit comments

Comments
 (0)