diff options
author | Tyler Gill <tyler.gill@byu.net> | 2017-09-22 08:44:46 +0300 |
---|---|---|
committer | Tyler Gill <tyler.gill@byu.net> | 2017-09-22 08:44:46 +0300 |
commit | e78e40fb11efd11124194b07a5f8da31986ca24d (patch) | |
tree | 9bce34077fbf9a431ebf77f585e5f08bb1ce1d23 /Duplicati/Library/Interface | |
parent | 811acac0737a8975f7531fe08136ee86a5d94cba (diff) |
Fix some documentation errors in backend interfaces.
Diffstat (limited to 'Duplicati/Library/Interface')
-rw-r--r-- | Duplicati/Library/Interface/IBackend.cs | 3 | ||||
-rw-r--r-- | Duplicati/Library/Interface/IRenameEnabledBackend.cs | 10 |
2 files changed, 5 insertions, 8 deletions
diff --git a/Duplicati/Library/Interface/IBackend.cs b/Duplicati/Library/Interface/IBackend.cs index df78a28d7..a8b5532b9 100644 --- a/Duplicati/Library/Interface/IBackend.cs +++ b/Duplicati/Library/Interface/IBackend.cs @@ -48,7 +48,6 @@ namespace Duplicati.Library.Interface /// <summary>
/// Returns a list of files found on the remote location
/// </summary>
- /// <param name="url">The url passed</param>
/// <returns>The list of files</returns>
List<IFileEntry> List();
@@ -82,7 +81,7 @@ namespace Duplicati.Library.Interface /// </summary>
string Description { get; }
- /// <summary>
+ /// <summary>
/// The purpose of this method is to test the connection to the remote backend.
/// If any problem is encountered, this method should throw an exception.
/// If the encountered problem is a missing target "folder",
diff --git a/Duplicati/Library/Interface/IRenameEnabledBackend.cs b/Duplicati/Library/Interface/IRenameEnabledBackend.cs index 1185b8c53..550e098e9 100644 --- a/Duplicati/Library/Interface/IRenameEnabledBackend.cs +++ b/Duplicati/Library/Interface/IRenameEnabledBackend.cs @@ -24,17 +24,15 @@ using System.Text; namespace Duplicati.Library.Interface
{
/// <summary>
- /// An interface a backend may implement if it supports streaming operations.
- /// Backends that implement this interface can be throttled and correctly shows
- /// the progressbar when transfering data.
+ /// An interface a backend may implement if it supports rename operations.
/// </summary>
public interface IRenameEnabledBackend : IBackend
{
/// <summary>
- /// Puts the content of the file to the url passed
+ /// Renames the file
/// </summary>
- /// <param name="remotename">The remote filename, relative to the URL</param>
- /// <param name="stream">The stream to read from</param>
+ /// <param name="oldname">The old filename, relative to the root</param>
+ /// <param name="newname">The new filename, relative to the root</param>
void Rename(string oldname, string newname);
}
}
|