Commit c1034f40 authored by Raphael Kubo da Costa's avatar Raphael Kubo da Costa
Browse files

Add class-level apidox to AddToArchive and BatchExtract

svn path=/trunk/KDE/kdeutils/ark/; revision=1001614
parent 523653fb
...@@ -28,6 +28,17 @@ ...@@ -28,6 +28,17 @@
#include <KJob> #include <KJob>
#include <KUrl> #include <KUrl>
/**
* Compresses all input files into an archive.
*
* This is a job class that creates a compressed archive
* with all the given input files.
*
* It provides the functionality for the --add command-line
* option, and does not need the GUI to be running.
*
* @author Harald Hvaal <haraldhv@stud.ntnu.no>
*/
namespace Kerfuffle namespace Kerfuffle
{ {
class KERFUFFLE_EXPORT AddToArchive : public KJob class KERFUFFLE_EXPORT AddToArchive : public KJob
......
...@@ -32,6 +32,14 @@ ...@@ -32,6 +32,14 @@
#include <QtCore/QString> #include <QtCore/QString>
#include <QtCore/QStringList> #include <QtCore/QStringList>
/**
* This class schedules the extraction of all given compressed archives.
*
* Like AddToArchive, this class does not need the GUI to be active, and
* provides the functionality avaliable from the --batch command-line option.
*
* @author Harald Hvaal <haraldhv@stud.ntnu.no>
*/
namespace Kerfuffle namespace Kerfuffle
{ {
class Archive; class Archive;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment