Skip to content

Commit

Permalink
fix method comments
Browse files Browse the repository at this point in the history
  • Loading branch information
robinrodricks committed Sep 29, 2020
1 parent eccfe55 commit a03eab0
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
4 changes: 2 additions & 2 deletions FluentFTP/Client/FtpClient_FileDownload.cs
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ public async Task<int> DownloadFilesAsync(string localDir, IEnumerable<string> r
/// <param name="existsMode">If the file exists on disk, should we skip it, resume the download or restart the download?</param>
/// <param name="verifyOptions">Sets if checksum verification is required for a successful download and what to do if it fails verification (See Remarks)</param>
/// <param name="progress">Provide a callback to track download progress.</param>
/// <returns>If true then the file was downloaded, false otherwise.</returns>
/// <returns>FtpStatus flag indicating if the file was downloaded, skipped or failed to transfer.</returns>
/// <remarks>
/// If verification is enabled (All options other than <see cref="FtpVerify.None"/>) the hash will be checked against the server. If the server does not support
/// any hash algorithm, then verification is ignored. If only <see cref="FtpVerify.OnlyChecksum"/> is set then the return of this method depends on both a successful
Expand Down Expand Up @@ -371,7 +371,7 @@ private FtpStatus DownloadFileToFile(string localPath, string remotePath, FtpLoc
/// <param name="verifyOptions">Sets if checksum verification is required for a successful download and what to do if it fails verification (See Remarks)</param>
/// <param name="progress">Provide an implementation of IProgress to track download progress.</param>
/// <param name="token">The token that can be used to cancel the entire process</param>
/// <returns>If true then the file was downloaded, false otherwise.</returns>
/// <returns>FtpStatus flag indicating if the file was downloaded, skipped or failed to transfer.</returns>
/// <remarks>
/// If verification is enabled (All options other than <see cref="FtpVerify.None"/>) the hash will be checked against the server. If the server does not support
/// any hash algorithm, then verification is ignored. If only <see cref="FtpVerify.OnlyChecksum"/> is set then the return of this method depends on both a successful
Expand Down
8 changes: 4 additions & 4 deletions FluentFTP/Client/FtpClient_FileUpload.cs
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ private async Task PurgeSuccessfulUploadsAsync(IEnumerable<string> remotePaths)
/// <param name="createRemoteDir">Create the remote directory if it does not exist. Slows down upload due to additional checks required.</param>
/// <param name="verifyOptions">Sets if checksum verification is required for a successful upload and what to do if it fails verification (See Remarks)</param>
/// <param name="progress">Provide a callback to track download progress.</param>
/// <returns>If true then the file was uploaded, false otherwise.</returns>
/// <returns>FtpStatus flag indicating if the file was uploaded, skipped or failed to transfer.</returns>
/// <remarks>
/// If verification is enabled (All options other than <see cref="FtpVerify.None"/>) the hash will be checked against the server. If the server does not support
/// any hash algorithm, then verification is ignored. If only <see cref="FtpVerify.OnlyChecksum"/> is set then the return of this method depends on both a successful
Expand Down Expand Up @@ -413,7 +413,7 @@ private FtpStatus UploadFileFromFile(string localPath, string remotePath, bool c
/// <param name="verifyOptions">Sets if checksum verification is required for a successful upload and what to do if it fails verification (See Remarks)</param>
/// <param name="token">The token that can be used to cancel the entire process.</param>
/// <param name="progress">Provide an implementation of IProgress to track upload progress.</param>
/// <returns>If true then the file was uploaded, false otherwise.</returns>
/// <returns>FtpStatus flag indicating if the file was uploaded, skipped or failed to transfer.</returns>
/// <remarks>
/// If verification is enabled (All options other than <see cref="FtpVerify.None"/>) the hash will be checked against the server. If the server does not support
/// any hash algorithm, then verification is ignored. If only <see cref="FtpVerify.OnlyChecksum"/> is set then the return of this method depends on both a successful
Expand Down Expand Up @@ -571,7 +571,7 @@ public FtpStatus Upload(byte[] fileData, string remotePath, FtpRemoteExists exis
/// <param name="createRemoteDir">Create the remote directory if it does not exist. Slows down upload due to additional checks required.</param>
/// <param name="token">The token that can be used to cancel the entire process.</param>
/// <param name="progress">Provide an implementation of IProgress to track upload progress.</param>
/// <returns>If true then the file was uploaded, false otherwise.</returns>
/// <returns>FtpStatus flag indicating if the file was uploaded, skipped or failed to transfer.</returns>
public async Task<FtpStatus> UploadAsync(Stream fileStream, string remotePath, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, bool createRemoteDir = false, IProgress<FtpProgress> progress = null, CancellationToken token = default(CancellationToken)) {
// verify args
if (fileStream == null) {
Expand Down Expand Up @@ -600,7 +600,7 @@ public FtpStatus Upload(byte[] fileData, string remotePath, FtpRemoteExists exis
/// <param name="createRemoteDir">Create the remote directory if it does not exist. Slows down upload due to additional checks required.</param>
/// <param name="token">The token that can be used to cancel the entire process.</param>
/// <param name="progress">Provide an implementation of IProgress to track upload progress.</param>
/// <returns>If true then the file was uploaded, false otherwise.</returns>
/// <returns>FtpStatus flag indicating if the file was uploaded, skipped or failed to transfer.</returns>
public async Task<FtpStatus> UploadAsync(byte[] fileData, string remotePath, FtpRemoteExists existsMode = FtpRemoteExists.Overwrite, bool createRemoteDir = false, IProgress<FtpProgress> progress = null, CancellationToken token = default(CancellationToken)) {
// verify args
if (fileData == null) {
Expand Down
Binary file modified Powershell/FluentFTP.dll
Binary file not shown.
3 changes: 2 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Release Notes

#### 32.4.6
- Upgrade System.Net.Security from version 4.3.0 to 4.3.2 to fix security issues
- Upgrade `System.Net.Security` from version 4.3.0 to 4.3.2 to fix security issues
- Fix comment for `UploadFile`/`UploadFileAsync`/`DownloadFile`/`DownloadFileAsync` methods

#### 32.4.5
- Fix: Uncatchable NullReferenceException is occasionally thrown from `ConnectAsync`
Expand Down

0 comments on commit a03eab0

Please sign in to comment.