Skip to content

Commit

Permalink
Update ZipFile comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
jfreilly committed Nov 4, 2006
1 parent 6672b9b commit 00ba7d3
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions src/Zip/ZipFile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1165,7 +1165,7 @@ public int BufferSize
}

/// <summary>
/// Get a value indicating an update is in progress.
/// Get a value indicating an update has <see cref="BeginUpdate">been started</see>.
/// </summary>
public bool IsUpdating
{
Expand All @@ -1186,10 +1186,10 @@ public bool IsUpdating
#endregion
#region Deferred Updating
/// <summary>
/// Begin updating this <see cref="ZipFile"/> instance.
/// Begin updating this <see cref="ZipFile"/> archive.
/// </summary>
/// <param name="archiveStorage">The archive storage for use during the update.</param>
/// <param name="dataSource">The data source to utilise during updating.</param>
/// <param name="archiveStorage">The <see cref="IArchiveStorage">archive storage</see> for use during the update.</param>
/// <param name="dataSource">The <see cref="IDynamicDataSource">data source</see> to utilise during updating.</param>
public void BeginUpdate(IArchiveStorage archiveStorage, IDynamicDataSource dataSource)
{
if ( IsEmbeddedArchive ) {
Expand Down Expand Up @@ -1225,16 +1225,19 @@ public void BeginUpdate(IArchiveStorage archiveStorage, IDynamicDataSource dataS
}

/// <summary>
/// Begin an update to thsi archive.
/// Begin updating to this <see cref="ZipFile"/> archive.
/// </summary>
/// <param name="archiveStorage">The storage to use during the update.</param>
public void BeginUpdate(IArchiveStorage archiveStorage)
{
BeginUpdate(archiveStorage, new DynamicDiskDataSource());
}

/// <summary>
/// Begin updating this <see cref="ZipFile"/> instance.
/// Begin updating this <see cref="ZipFile"/> archive.
/// </summary>
/// <seealso cref="CommitUpdate"></seealso>
/// <seealso cref="AbortUpdate"></seealso>
public void BeginUpdate()
{
if ( Name == null ) {
Expand All @@ -1248,6 +1251,8 @@ public void BeginUpdate()
/// <summary>
/// Commit current updates, updating this archive.
/// </summary>
/// <seealso cref="BeginUpdate"></seealso>
/// <seealso cref="AbortUpdate"></seealso>
public void CommitUpdate()
{
CheckUpdating();
Expand All @@ -1272,8 +1277,10 @@ public void CommitUpdate()
}

/// <summary>
/// Abort an update.
/// Abort updating leaving the archive unchanged.
/// </summary>
/// <seealso cref="BeginUpdate"></seealso>
/// <seealso cref="CommitUpdate"></seealso>
public void AbortUpdate()
{
updates_ = null;
Expand Down Expand Up @@ -1398,7 +1405,7 @@ public void AddDirectory(string directoryName)
#region Modifying Entries
/* Modify not yet ready for public consumption.
Direct modification of an entry should not overwrite original data before its read.
Sufe mode is trivial in this sense.
Safe mode is trivial in this sense.
public void Modify(ZipEntry original, ZipEntry updated)
{
if ( original == null ) {
Expand Down Expand Up @@ -1533,7 +1540,6 @@ void WriteLocalEntryHeader(ZipUpdate update)
}

WriteLEShort(( byte )entry.CompressionMethod);

WriteLEInt(( int )entry.DosTime);

if ( !entry.HasCrc ) {
Expand Down Expand Up @@ -1677,7 +1683,7 @@ int WriteCentralDirectoryHeader(ZipEntry entry)
ed.AddNewEntry(1);
}
else {
// Should already be done when local header was added.
// Should have already be done when local header was added.
ed.Delete(1);
}

Expand Down

0 comments on commit 00ba7d3

Please sign in to comment.