Skip to content

Commit 00ba7d3

Browse files
committed
Update ZipFile comments.
1 parent 6672b9b commit 00ba7d3

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

src/Zip/ZipFile.cs

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,7 @@ public int BufferSize
11651165
}
11661166

11671167
/// <summary>
1168-
/// Get a value indicating an update is in progress.
1168+
/// Get a value indicating an update has <see cref="BeginUpdate">been started</see>.
11691169
/// </summary>
11701170
public bool IsUpdating
11711171
{
@@ -1186,10 +1186,10 @@ public bool IsUpdating
11861186
#endregion
11871187
#region Deferred Updating
11881188
/// <summary>
1189-
/// Begin updating this <see cref="ZipFile"/> instance.
1189+
/// Begin updating this <see cref="ZipFile"/> archive.
11901190
/// </summary>
1191-
/// <param name="archiveStorage">The archive storage for use during the update.</param>
1192-
/// <param name="dataSource">The data source to utilise during updating.</param>
1191+
/// <param name="archiveStorage">The <see cref="IArchiveStorage">archive storage</see> for use during the update.</param>
1192+
/// <param name="dataSource">The <see cref="IDynamicDataSource">data source</see> to utilise during updating.</param>
11931193
public void BeginUpdate(IArchiveStorage archiveStorage, IDynamicDataSource dataSource)
11941194
{
11951195
if ( IsEmbeddedArchive ) {
@@ -1225,16 +1225,19 @@ public void BeginUpdate(IArchiveStorage archiveStorage, IDynamicDataSource dataS
12251225
}
12261226

12271227
/// <summary>
1228-
/// Begin an update to thsi archive.
1228+
/// Begin updating to this <see cref="ZipFile"/> archive.
12291229
/// </summary>
12301230
/// <param name="archiveStorage">The storage to use during the update.</param>
12311231
public void BeginUpdate(IArchiveStorage archiveStorage)
12321232
{
12331233
BeginUpdate(archiveStorage, new DynamicDiskDataSource());
12341234
}
1235+
12351236
/// <summary>
1236-
/// Begin updating this <see cref="ZipFile"/> instance.
1237+
/// Begin updating this <see cref="ZipFile"/> archive.
12371238
/// </summary>
1239+
/// <seealso cref="CommitUpdate"></seealso>
1240+
/// <seealso cref="AbortUpdate"></seealso>
12381241
public void BeginUpdate()
12391242
{
12401243
if ( Name == null ) {
@@ -1248,6 +1251,8 @@ public void BeginUpdate()
12481251
/// <summary>
12491252
/// Commit current updates, updating this archive.
12501253
/// </summary>
1254+
/// <seealso cref="BeginUpdate"></seealso>
1255+
/// <seealso cref="AbortUpdate"></seealso>
12511256
public void CommitUpdate()
12521257
{
12531258
CheckUpdating();
@@ -1272,8 +1277,10 @@ public void CommitUpdate()
12721277
}
12731278

12741279
/// <summary>
1275-
/// Abort an update.
1280+
/// Abort updating leaving the archive unchanged.
12761281
/// </summary>
1282+
/// <seealso cref="BeginUpdate"></seealso>
1283+
/// <seealso cref="CommitUpdate"></seealso>
12771284
public void AbortUpdate()
12781285
{
12791286
updates_ = null;
@@ -1398,7 +1405,7 @@ public void AddDirectory(string directoryName)
13981405
#region Modifying Entries
13991406
/* Modify not yet ready for public consumption.
14001407
Direct modification of an entry should not overwrite original data before its read.
1401-
Sufe mode is trivial in this sense.
1408+
Safe mode is trivial in this sense.
14021409
public void Modify(ZipEntry original, ZipEntry updated)
14031410
{
14041411
if ( original == null ) {
@@ -1533,7 +1540,6 @@ void WriteLocalEntryHeader(ZipUpdate update)
15331540
}
15341541

15351542
WriteLEShort(( byte )entry.CompressionMethod);
1536-
15371543
WriteLEInt(( int )entry.DosTime);
15381544

15391545
if ( !entry.HasCrc ) {
@@ -1677,7 +1683,7 @@ int WriteCentralDirectoryHeader(ZipEntry entry)
16771683
ed.AddNewEntry(1);
16781684
}
16791685
else {
1680-
// Should already be done when local header was added.
1686+
// Should have already be done when local header was added.
16811687
ed.Delete(1);
16821688
}
16831689

0 commit comments

Comments
 (0)