summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElvis Angelaccio <[email protected]>2018-01-03 13:18:34 +0100
committerElvis Angelaccio <[email protected]>2018-01-03 13:18:34 +0100
commita3db7e0c82982593b1563e3e42fdee9e4187b79e (patch)
tree85988a871f027906b1ff5049a00837340d48c723
parentd5fdd114f01c5b00294db04ff303948d1b385371 (diff)
Add apidox for ReadWriteArchiveInterface::addFiles()
-rw-r--r--kerfuffle/archiveinterface.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/kerfuffle/archiveinterface.h b/kerfuffle/archiveinterface.h
index d981971..acb9555 100644
--- a/kerfuffle/archiveinterface.h
+++ b/kerfuffle/archiveinterface.h
@@ -220,6 +220,15 @@ public:
bool isReadOnly() const override;
+ /**
+ * Adds the given @p files under the given @p destination.
+ * If @p destination is null, the files will be added under the root of the archive.
+ * @param options The compression options that must be respected.
+ * @param numberOfEntriesToAdd The total number of entries the will be added.
+ * @return Whether the operation succeeded.
+ * @note If returning false, make sure to emit the error() signal beforewards to notify
+ * the user of the error condition.
+ */
virtual bool addFiles(const QVector<Archive::Entry*> &files, const Archive::Entry *destination, const CompressionOptions& options, uint numberOfEntriesToAdd = 0) = 0;
virtual bool moveFiles(const QVector<Archive::Entry*> &files, Archive::Entry *destination, const CompressionOptions& options) = 0;
virtual bool copyFiles(const QVector<Archive::Entry*> &files, Archive::Entry *destination, const CompressionOptions& options) = 0;