Skip to content

Commit

Permalink
Add exception documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nihlus committed Oct 19, 2017
1 parent 33a2ea0 commit 64c4e3d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions libwarcraft/MPQ/MPQ.cs
Expand Up @@ -309,6 +309,7 @@ public IEnumerable<string> GetInternalFileList()
/// return an empty list.
/// </summary>
/// <returns>The external file list.</returns>
/// <exception cref="ObjectDisposedException">Thrown if the archive has been disposed.</exception>
public IEnumerable<string> GetExternalFileList()
{
ThrowIfDisposed();
Expand All @@ -320,6 +321,7 @@ public IEnumerable<string> GetExternalFileList()
/// Sets the file list to the provided listfile.
/// </summary>
/// <param name="inExternalListfile">In external listfile.</param>
/// <exception cref="ObjectDisposedException">Thrown if the archive has been disposed.</exception>
public void SetFileList(List<string> inExternalListfile)
{
ThrowIfDisposed();
Expand All @@ -331,6 +333,7 @@ public void SetFileList(List<string> inExternalListfile)
/// Resets the external file list, clearing it of any entries. The internal list file (if there is one)
/// will be used instead.
/// </summary>
/// <exception cref="ObjectDisposedException">Thrown if the archive has been disposed.</exception>
public void ResetExternalFileList()
{
ThrowIfDisposed();
Expand All @@ -339,6 +342,7 @@ public void ResetExternalFileList()
}

/// <inheritdoc />
/// <exception cref="ObjectDisposedException">Thrown if the archive has been disposed.</exception>
public bool ContainsFile(string filePath)
{
ThrowIfDisposed();
Expand All @@ -356,6 +360,8 @@ public bool ContainsFile(string filePath)
}

/// <inheritdoc />
/// <exception cref="ObjectDisposedException">Thrown if the archive has been disposed.</exception>
/// <exception cref="FileNotFoundException">Thrown if the archive does not contain a file at the given path.</exception>
public MPQFileInfo GetFileInfo(string filePath)
{
ThrowIfDisposed();
Expand All @@ -377,6 +383,9 @@ public MPQFileInfo GetFileInfo(string filePath)
}

/// <inheritdoc />
/// <exception cref="ObjectDisposedException">Thrown if the archive has been disposed.</exception>
/// <exception cref="FileNotFoundException">Thrown if the archive does not contain a file at the given path.</exception>
/// <exception cref="FileDeletedException">Thrown if the file is deleted in the archive.</exception>
public byte[] ExtractFile(string filePath)
{
ThrowIfDisposed();
Expand Down

0 comments on commit 64c4e3d

Please sign in to comment.