doxygen updates

svn path=/trunk/extragear/sysadmin/partitionmanager/; revision=1128312
This commit is contained in:
Volker Lanz 2010-05-18 22:27:30 +00:00
parent 2069e191de
commit d058abce6e
105 changed files with 445 additions and 202 deletions

6
TODO
View File

@ -9,6 +9,12 @@ Bugs to fix for 1.1:
if the new one is not legal. i.e., we must constantly update the valid ranges
of the spin boxes if any value changes.
* why does CoreBackendPartitionTable::detectFileSystemBySector() take a Device
and not a CoreBackendDevice?
* why can't CoreBackendPartitionTable::createPartition() return an int and use 0
or -1 as error code and otherwise return the new number?
===============================================================================
For releases after 1.1:

View File

@ -35,6 +35,11 @@ class KAboutData;
class QString;
/**
* Interface class for backend plugins.
* @author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackend : public QObject
{
Q_OBJECT
@ -47,20 +52,88 @@ class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackend : public QObject
virtual ~CoreBackend();
signals:
void progress(int);
void scanProgress(const QString&,int);
/**
* Emitted to inform about progress of any kind.
* @param i the progress in percent (from 0 to 100)
*/
void progress(int i);
/**
* Emitted to inform about scan progress.
* @param device_node the device being scanned just now (e.g. "/dev/sda")
* @param i the progress in percent (from 0 to 100)
*/
void scanProgress(const QString& device_node, int i);
public:
/**
* Return the plugin's KAboutData
* @return the plugin's KAboutData
*/
virtual const KAboutData& about() const { return *m_AboutData; }
/**
* Initialize the plugin's FileSystem support
*/
virtual void initFSSupport() = 0;
/**
* Scan for devices in the system.
* @return a QList of pointers to Device instances. The caller is responsible
* for deleting these objects.
*/
virtual QList<Device*> scanDevices() = 0;
/**
* Scan a single device in the system.
* @param device_node The path to the device that is to be scanned (e.g. /dev/sda)
* @return a pointer to a Device instance. The caller is responsible for deleting
* this object.
*/
virtual Device* scanDevice(const QString& device_node) = 0;
/**
* Open a device for reading.
* @param device_node The path of the device that is to be opened (e.g. /dev/sda)
* @return a pointer to a CoreBackendDevice or NULL if the open failed. If a pointer to
* an instance is returned, it's the caller's responsibility to delete the
* object.
*/
virtual CoreBackendDevice* openDevice(const QString& device_node) = 0;
/**
* Open a device in exclusive mode for writing.
* @param device_node The path of the device that is to be opened (e.g. /dev/sda)
* @return a pointer to a CoreBackendDevice or NULL if the open failed. If a pointer to
* an instance is returned, it's the caller's responsibility to delete the
* object.
*/
virtual CoreBackendDevice* openDeviceExclusive(const QString& device_node) = 0;
/**
* Close a CoreBackendDevice that has previously been opened.
* @param core_device Pointer to the CoreBackendDevice to be closed. Must not be NULL.
* @return true if closing the CoreBackendDevice succeeded, otherwise false.
*
* This method does not delete the object.
*/
virtual bool closeDevice(CoreBackendDevice* core_device) = 0;
/**
* Emit progress.
* @param i the progress in percent (from 0 to 100)
* This is used to emit a progress() signal from somewhere deep inside the plugin
* backend code if that is ever necessary.
*/
virtual void emitProgress(int i);
/**
* Emit scan progress.
* @param device_node the path to the device just being scanned (e.g. /dev/sda)
* @param i the progress in percent (from 0 to 100)
* This is used to emit a scanProgress() signal from the backend device scanning
* code.
*/
virtual void emitScanProgress(const QString& device_node, int i);
protected:

View File

@ -32,6 +32,10 @@ class Partition;
class PartitionTable;
class Report;
/**
* Interface class representing a device in the backend plugin.
* @author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackendDevice
{
public:
@ -39,18 +43,67 @@ class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackendDevice
virtual ~CoreBackendDevice() {}
public:
/**
* Get the device path for this device (e.g. "/dev/sda")
* @return the device path
*/
virtual const QString& deviceNode() const { return m_DeviceNode; }
/**
* Determine if this device is opened in exclusive mode.
* @return true if it is opened in exclusive mode, otherwise false
*/
virtual bool isExclusive() const { return m_Exclusive; }
/**
* Open the backend device
* @return true if successful
*/
virtual bool open() = 0;
/**
* Open the backend device in exclusive mode
* @return true if successful
*/
virtual bool openExclusive() = 0;
/**
* Close the backend device
* @return true if successful
*/
virtual bool close() = 0;
/**
* Open this backend device's partition table
* @return a pointer to the CoreBackendPartitionTable for this device or NULL in case
* of errors
*/
virtual CoreBackendPartitionTable* openPartitionTable() = 0;
/**
* Create a new partition table on this device.
* @param report the Report to write information to
* @param ptable the PartitionTable to create on this backend device
* @return true if successful
*/
virtual bool createPartitionTable(Report& report, const PartitionTable& ptable) = 0;
/**
* Read sectors from an opened device into a buffer.
* @param buffer the buffer to write the read data to
* @param offset offset sector where to start reading on the device
* @param numSectors number of sectors to read
* @return true on success
*/
virtual bool readSectors(void* buffer, qint64 offset, qint64 numSectors) = 0;
/**
* Write sectors from a buffer to an exclusively opened device.
* @param buffer the buffer with the data
* @param offset offset sector where to start writing to the device
* @param numSectors number of sectors to write
* @return true on success
*/
virtual bool writeSectors(void* buffer, qint64 offset, qint64 numSectors) = 0;
protected:

View File

@ -29,18 +29,49 @@ class QString;
class QStringList;
class CoreBackend;
/**
* The backend manager class.
*
* This is basically a singleton class to give the application access to the currently
* selected backend and also to manage the available backend plugins.
* @author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackendManager
{
private:
CoreBackendManager();
public:
/**
* @return pointer to ourselves
*/
static CoreBackendManager* self();
/**
* @return the name of the default backend plugin
*/
static QString defaultBackendName() { return "pmlibpartedbackendplugin"; }
/**
* @return a list of available backend plugins
*/
KService::List list() const;
/**
* Loads the given backend plugin into the application.
* @param name the name of the plugin to load
* @return true on success
*/
bool load(const QString& name);
/**
* Unload the current plugin.
*/
void unload();
/**
* @return a pointer to the currently loaded backend
*/
CoreBackend* backend() { return m_Backend; }
private:

View File

@ -27,6 +27,10 @@
class Report;
/**
* Represents a partition in the backend plugin.
* @author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackendPartition
{
public:
@ -34,6 +38,13 @@ class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackendPartition
virtual ~CoreBackendPartition() {}
public:
/**
* Set a flag for the partition
* @param report the Report to write information to
* @param flag the flag to set
* @param state the state to set the flag to (i.e., on or off)
* @return true on success
*/
virtual bool setFlag(Report& report, PartitionTable::Flag flag, bool state) = 0;
};

View File

@ -26,29 +26,98 @@
#include "fs/filesystem.h"
#include <qglobal.h>
#include <fatlabel/partition.h>
class CoreBackendPartition;
class Report;
class Partition;
/**
* Interface class to represent a partition table in the backend.
* @author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT CoreBackendPartitionTable
{
public:
virtual ~CoreBackendPartitionTable() {}
public:
/**
* Open the partition table
* @return true on success
*/
virtual bool open() = 0;
/**
* Commit changes to the partition table to disk and to the OS.
* @param timeout timeout in seconds to wait for the commit to succeed
* @return true on success
*/
virtual bool commit(quint32 timeout = 10) = 0;
/**
* @return pointer to the extended partition as a CoreBackendPartition or NULL if there is none
*/
virtual CoreBackendPartition* getExtendedPartition() = 0;
/**
* @param sector sector the partition occupies
* @return the CoreBackendPartition to occupy the given sector or NULL if not found
*/
virtual CoreBackendPartition* getPartitionBySector(qint64 sector) = 0;
/**
* Delete a partition.
* @param report the report to write information to
* @param partition the Partition to delete
* @return true on success
*/
virtual bool deletePartition(Report& report, const Partition& partition) = 0;
/**
* Delete a file system on disk so it cannot be detected anymore.
* @param report the report to write information to
* @param partition the Partition for which to clobber the file system
* @return true on success
*/
virtual bool clobberFileSystem(Report& report, const Partition& partition) = 0;
/**
* Resize a file system to a new length.
* @param report the report to write information to
* @param partition the partition the FileSystem to resize is on
* @param newLength the new length for the FileSystem in sectors
* @return true on success
*/
virtual bool resizeFileSystem(Report& report, const Partition& partition, qint64 newLength) = 0;
/**
* Detect which FileSystem is present at a given start sector.
* @param report the report to write information to
* @param device the Device on which the FileSystem resides
* @param sector the sector where to look for a FileSystem
* @return the detected FileSystem::Type
*/
virtual FileSystem::Type detectFileSystemBySector(Report& report, const Device& device, qint64 sector) = 0;
/**
* Create a new partition.
* @param report the report to write information to
* @param partition the new partition to create on disk
* @param new_number output value holding the new number the OS sees the partition under
* (e.g. 7 for "/dev/sda7")
* @return true on success
*/
virtual bool createPartition(Report& report, const Partition& partition, quint32& new_number) = 0;
/**
* Update the geometry for a partition in the partition table.
* @param report the report to write information to
* @param partition the partition to update the geometry for
* @param sector_start the new start sector for the partition
* @param sector_end the new last sector for the partition
* @return true on success
*/
virtual bool updateGeometry(Report& report, const Partition& partition, qint64 sector_start, qint64 sector_end) = 0;
};

View File

@ -25,13 +25,13 @@
class CopyTarget;
/** @brief Base class for something to copy from.
/** Base class for something to copy from.
Abstract base class for all copy sources. Used in combination with CopyTarget
to implement moving, copying, backing up and restoring FileSystems.
@see CopyTarget
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopySource
{

View File

@ -29,11 +29,11 @@ class Device;
class CopyTarget;
class CoreBackendDevice;
/** @brief A Device to copy from.
/** A Device to copy from.
Represents a Device to copy from. Used to copy a Partition to somewhere on the same or
another Device or to backup its FileSystem to a file.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopySourceDevice : public CopySource
{

View File

@ -29,11 +29,11 @@
class QString;
class CopyTarget;
/** @brief A file to copy from.
/** A file to copy from.
Represents a file to copy from. Used to restore a FileSystem from a backup file.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopySourceFile : public CopySource
{

View File

@ -27,11 +27,11 @@
class CopyTarget;
/** @brief A source for securely overwriting a partition (shredding).
/** A source for securely overwriting a partition (shredding).
Represents a source of data (random or zeros) to copy from. Used to securely overwrite data on disk.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopySourceShred : public CopySource
{

View File

@ -24,13 +24,13 @@
#include <qglobal.h>
/** @brief Base class for something to copy to.
/** Base class for something to copy to.
Abstract base class for all copy targets. Used together with CopySource to
implement moving, copying, restoring and backing up FileSystems.
@see CopySource
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopyTarget
{

View File

@ -28,14 +28,14 @@
class Device;
class CoreBackendDevice;
/** @brief A Device to copy to.
/** A Device to copy to.
Represents a target Device to copy to. Used to copy a Partition to somewhere on the same
or another Device or to restore a FileSystem from a file to a Partition.
@see CopyTargetFile, CopySourceDevice
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopyTargetDevice : public CopyTarget
{

View File

@ -28,12 +28,12 @@
class QString;
/** @brief A file to copy to.
/** A file to copy to.
Repesents a target file to copy to. Used to back up a FileSystem to a file.
@see CopySourceFile, CopyTargetDevice
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopyTargetFile : public CopyTarget
{

View File

@ -32,14 +32,14 @@ class CreatePartitionTableOperation;
class CoreBackend;
class SmartStatus;
/** @brief A device.
/** A device.
Represents a device like /dev/sda.
Devices are the outermost entity; they contain a PartitionTable that itself contains Partitions.
@see PartitionTable, Partition
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT Device : public QObject
{

View File

@ -24,11 +24,11 @@
class OperationStack;
/** @brief Thread to scan for all available Devices on this computer.
/** Thread to scan for all available Devices on this computer.
This class is used to find all Devices on the computer and to create new Device instances for each of them. It's subclassing QThread to run asynchronously.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class DeviceScanner : public QThread
{

View File

@ -29,11 +29,11 @@ class Operation;
class OperationStack;
class Report;
/** @brief Thread to run the Operations in the OperationStack.
/** Thread to run the Operations in the OperationStack.
Runs the OperationStack when the user applies operations.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class OperationRunner : public QThread
{

View File

@ -32,12 +32,12 @@ class Partition;
class Operation;
class DeviceScanner;
/** @brief The list of Operations the user wants to have performed.
/** The list of Operations the user wants to have performed.
OperationStack also handles the Devices that were found on this computer and the merging of
Operations, e.g., when the user first creates a Partition, then deletes it.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class OperationStack : public QObject
{

View File

@ -62,7 +62,7 @@ class Report;
class QString;
class QTextStream;
/** @brief A partition or some unallocated space on a Device.
/** A partition or some unallocated space on a Device.
Repesent partitions in a PartitionTable on a Device. Partitions can be unallocated, thus not all
instances really are partitions in the way the user would see them.
@ -70,7 +70,7 @@ class QTextStream;
Extended partitions have child objects that represent the logicals inside them.
@see PartitionTable, Device, FileSystem
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT Partition : public PartitionNode
{

View File

@ -28,13 +28,13 @@
class Partition;
class PartitionRole;
/** @brief A node in the tree of partitions.
/** A node in the tree of partitions.
The root in this tree is the PartitionTable. The primaries are the child nodes; extended partitions again
have child nodes.
@see Device, PartitionTable, Partition
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class PartitionNode : public QObject
{

View File

@ -27,11 +27,11 @@
class QString;
/** @brief A Partition's role.
/** A Partition's role.
Each Partition has a PartitionRole: It can be primary, extended, logical or represent unallocated space on the Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT PartitionRole
{

View File

@ -35,13 +35,13 @@ class CoreBackend;
class QTextStream;
/** @brief The partition table (a.k.a Disk Label)
/** The partition table (a.k.a Disk Label)
PartitionTable represents a partition table (or disk label).
PartitionTable has child nodes that represent Partitions.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT PartitionTable : public PartitionNode
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A btrfs file system.
@author vl@fidra.de
/** A btrfs file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT btrfs : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief An ext2 file system.
@author vl@fidra.de
/** An ext2 file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ext2 : public FileSystem
{

View File

@ -33,11 +33,11 @@ class QString;
namespace FS
{
/** @brief An ext3 file system.
/** An ext3 file system.
Basically the same as ext2.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ext3 : public ext2
{

View File

@ -33,11 +33,11 @@ class QString;
namespace FS
{
/** @brief An ext4 file system.
/** An ext4 file system.
Basically the same as ext2.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ext4 : public ext2
{

View File

@ -31,12 +31,12 @@ class QString;
namespace FS
{
/** @brief An extended file system.
/** An extended file system.
A FileSystem for an extended Partition. Of course, extended partitions do not actually have
a file system, but we need this to be able to create, grow, shrink or move them.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT extended : public FileSystem

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A fat16 file system.
@author vl@fidra.de
/** A fat16 file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT fat16 : public FileSystem
{

View File

@ -33,11 +33,11 @@ class QString;
namespace FS
{
/** @brief A fat32 file system.
/** A fat32 file system.
Basically the same as a fat16 file system.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT fat32 : public fat16
{

View File

@ -29,12 +29,12 @@
class Device;
class Report;
/** @brief Base class for all FileSystems.
/** Base class for all FileSystems.
Represents a file system and handles support for various types of operations that can
be performed on those.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class FileSystem
{

View File

@ -30,8 +30,8 @@
class QString;
/** @brief Factory to create instances of FileSystem.
@author vl@fidra.de
/** Factory to create instances of FileSystem.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT FileSystemFactory
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief An hfs file system.
@author vl@fidra.de
/** An hfs file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT hfs : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief An hfsplus file system.
@author vl@fidra.de
/** An hfsplus file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT hfsplus : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A hpfs file system.
@author vl@fidra.de
/** A hpfs file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT hpfs : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A JFS file system.
@author vl@fidra.de
/** A JFS file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT jfs : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A linux swap pseudo file system.
@author vl@fidra.de
/** A linux swap pseudo file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT linuxswap : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A LUKS crypto file system.
@author vl@fidra.de
/** A LUKS crypto file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT luks : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief An NTFS file system.
@author vl@fidra.de
/** An NTFS file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ntfs : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A ocfs2 file system.
@author vl@fidra.de
/** A ocfs2 file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ocfs2 : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A Reiser4 file system.
@author vl@fidra.de
/** A Reiser4 file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT reiser4 : public FileSystem
{

View File

@ -35,8 +35,8 @@ class QString;
namespace FS
{
/** @brief A ReiserFS file system.
@author vl@fidra.de
/** A ReiserFS file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT reiserfs : public FileSystem
{

View File

@ -31,8 +31,8 @@ class QString;
namespace FS
{
/** @brief A UFS file system.
@author vl@fidra.de
/** A UFS file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ufs : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A pseudo file system for unformatted partitions.
@author vl@fidra.de
/** A pseudo file system for unformatted partitions.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT unformatted : public FileSystem
{

View File

@ -29,8 +29,8 @@
namespace FS
{
/** @brief A pseudo file system for partitions whose file system we cannot determine.
@author vl@fidra.de
/** A pseudo file system for partitions whose file system we cannot determine.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT unknown : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief An XFS file system.
@author vl@fidra.de
/** An XFS file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT xfs : public FileSystem
{

View File

@ -33,8 +33,8 @@ class QString;
namespace FS
{
/** @brief A zfs file system.
@author vl@fidra.de
/** A zfs file system.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT zfs : public FileSystem
{

View File

@ -23,8 +23,8 @@
#include "ui_applyprogressdetailswidgetbase.h"
/** @brief Details widget for the ProgressDialog.
@author vl@fidra.de
/** Details widget for the ProgressDialog.
@author Volker Lanz <vl@fidra.de>
*/
class ApplyProgressDetailsWidget : public QWidget, public Ui::ApplyProgressDetailsWidgetBase
{

View File

@ -39,11 +39,11 @@ class QTreeWidgetItem;
class QCloseEvent;
class QKeyEvent;
/** @brief Show progress.
/** Show progress.
The progress dialog telling the user about the progress of the Operations that are being applied.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class ApplyProgressDialog : public KDialog
{

View File

@ -23,8 +23,8 @@
#include "ui_applyprogressdialogwidgetbase.h"
/** @brief Central widget for the ProgressDialog.
@author vl@fidra.de
/** Central widget for the ProgressDialog.
@author Volker Lanz <vl@fidra.de>
*/
class ApplyProgressDialogWidget : public QWidget, public Ui::ApplyProgressDialogWidgetBase
{

View File

@ -29,11 +29,11 @@ class DevicePropsWidget;
class QWidget;
class QString;
/** @brief Show Device properties.
/** Show Device properties.
Dialog that shows a Device's properties.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class DevicePropsDialog : public KDialog
{

View File

@ -25,8 +25,8 @@
class PartTableWidget;
/** @brief Central widget in the DevicePropsDialog.
@author vl@fidra.de
/** Central widget in the DevicePropsDialog.
@author Volker Lanz <vl@fidra.de>
*/
class DevicePropsWidget : public QWidget, public Ui::DevicePropsWidgetBase
{

View File

@ -29,11 +29,11 @@
class KPushButton;
/** @brief Show supported Operations
/** Show supported Operations
Dialog to show which Operations are supported for which type of FileSystem.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class FileSystemSupportDialog : public KDialog
{

View File

@ -29,12 +29,12 @@ class Device;
class QGridLayout;
class QString;
/** @brief Show information about Partitions and Devices
/** Show information about Partitions and Devices
Child widget of the QDockWidget to show some details about the currently selected Partition
or Device
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class InfoPane : public QWidget
{

View File

@ -26,12 +26,12 @@
class Partition;
class Device;
/** @brief Base class for dialogs to insert Partitions.
/** Base class for dialogs to insert Partitions.
Base class for dialogs that need to insert a Partition into some unallocated space on
a Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class InsertDialog : public SizeDialogBase
{

View File

@ -33,8 +33,8 @@ class Device;
class QPoint;
class KActionCollection;
/** @brief A list of devices.
@author vl@fidra.de
/** A list of devices.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ListDevices : public QWidget, public Ui::ListDevicesBase
{

View File

@ -33,9 +33,9 @@ class Operation;
class QPoint;
class KActionCollection;
/** @brief A list of pending operations.
/** A list of pending operations.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT ListOperations : public QWidget, public Ui::ListOperationsBase
{

View File

@ -44,9 +44,9 @@ class QLabel;
class QCloseEvent;
class QEvent;
/** @brief The application's main window.
/** The application's main window.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT MainWindow : public KXmlGuiWindow, public Ui::MainWindowBase
{

View File

@ -29,11 +29,11 @@
class Device;
/** @brief Dialog to create new Partitions.
/** Dialog to create new Partitions.
Dialog to create a new Partition in some unallocated space on a Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class NewDialog : public SizeDialogBase
{

View File

@ -38,9 +38,9 @@ class QWidget;
class QLabel;
class QPoint;
/** @brief The central widget for the application.
/** The central widget for the application.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT PartitionManagerWidget : public QWidget, Ui::PartitionManagerWidgetBase
{

View File

@ -35,12 +35,12 @@ class QWidget;
class QString;
/** @brief Show Partition properties.
/** Show Partition properties.
Dialog that shows a Partition's properties and allows the user to change (or recreate)
the Partition's FileSystem, its label and its flags.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class PartPropsDialog : public KDialog
{

View File

@ -23,8 +23,8 @@
#include "ui_partpropswidgetbase.h"
/** @brief Central widget in the PartPropsDialog.
@author vl@fidra.de
/** Central widget in the PartPropsDialog.
@author Volker Lanz <vl@fidra.de>
*/
class PartPropsWidget : public QWidget, public Ui::PartPropsWidgetBase
{

View File

@ -34,8 +34,8 @@ class QPaintEvent;
class QResizeEvent;
class QMouseEvent;
/** @brief Widget that allows the user to resize a Partition.
@author vl@fidra.de
/** Widget that allows the user to resize a Partition.
@author Volker Lanz <vl@fidra.de>
*/
class PartResizerWidget : public QWidget
{

View File

@ -32,8 +32,8 @@ class PartitionTable;
class QResizeEvent;
class QMouseEvent;
/** @brief Widget that represents a PartitionTable.
@author vl@fidra.de
/** Widget that represents a PartitionTable.
@author Volker Lanz <vl@fidra.de>
*/
class PartTableWidget : public PartWidgetBase
{

View File

@ -30,11 +30,11 @@ class Partition;
class QPaintEvent;
class QResizeEvent;
/** @brief Widget that represents a Partition.
/** Widget that represents a Partition.
Represents a single Partition (possibly with its children, in case of an extended Partition) in the GUI.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class PartWidget : public PartWidgetBase
{

View File

@ -30,8 +30,8 @@ class Partition;
class PartWidget;
class QWidget;
/** @brief Base class for all widgets that need to position Partitions.
@author vl@fidra.de
/** Base class for all widgets that need to position Partitions.
@author Volker Lanz <vl@fidra.de>
*/
class PartWidgetBase : public QWidget
{

View File

@ -28,13 +28,13 @@
class Partition;
class Device;
/** @brief Let the user resize or move a Partition.
/** Let the user resize or move a Partition.
@todo The ResizeDialog does not yet have a "dirty bit".
It should get one and disable its OK button as long as nothing has been
modified, much like the PartPropsDialog already does.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class ResizeDialog : public SizeDialogBase
{

View File

@ -26,8 +26,8 @@
#include <QWidget>
#include <qdebug.h>
/** @brief Details widget for the SizeDetailsBase
@author vl@fidra.de
/** Details widget for the SizeDetailsBase
@author Volker Lanz <vl@fidra.de>
*/
class SizeDetailsWidget : public QWidget, public Ui::SizeDetailsWidgetBase
{

View File

@ -34,8 +34,8 @@ class PartitionTable;
class SizeDialogWidget;
class SizeDetailsWidget;
/** @brief Base class for all dialogs moving or resizing Partitions.
@author vl@fidra.de
/** Base class for all dialogs moving or resizing Partitions.
@author Volker Lanz <vl@fidra.de>
*/
class SizeDialogBase : public KDialog
{

View File

@ -26,8 +26,8 @@
#include <QWidget>
#include <qdebug.h>
/** @brief Central widget for the SizeDialogBase
@author vl@fidra.de
/** Central widget for the SizeDialogBase
@author Volker Lanz <vl@fidra.de>
*/
class SizeDialogWidget : public QWidget, public Ui::SizeDialogWidgetBase
{

View File

@ -30,11 +30,11 @@ class QWidget;
class QString;
class QPoint;
/** @brief Show SMART properties.
/** Show SMART properties.
Dialog that shows SMART status and properties for a device
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class SmartDialog : public KDialog
{

View File

@ -26,8 +26,8 @@
class QStyledItemDelegate;
class QPoint;
/** @brief Central widget in the SmartDialogWidget
@author vl@fidra.de
/** Central widget in the SmartDialogWidget
@author Volker Lanz <vl@fidra.de>
*/
class SmartDialogWidget : public QWidget, public Ui::SmartDialogWidgetBase
{

View File

@ -33,8 +33,8 @@
class QTreeWidget;
/** @brief A tree for formatted log output.
@author vl@fidra.de
/** A tree for formatted log output.
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT TreeLog: public QWidget, public Ui::TreeLogBase
{

View File

@ -29,11 +29,11 @@ class Partition;
class Device;
class Report;
/** @brief Back up a FileSystem.
/** Back up a FileSystem.
Backs up a FileSystem from a given Device and Partition to a file with the given filename.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class BackupFileSystemJob : public Job
{

View File

@ -28,8 +28,8 @@ class Report;
class QString;
/** @brief Check a FileSystem.
@author vl@fidra.de
/** Check a FileSystem.
@author Volker Lanz <vl@fidra.de>
*/
class CheckFileSystemJob : public Job
{

View File

@ -31,11 +31,11 @@ class Report;
class QString;
/** @brief Copy a FileSystem.
/** Copy a FileSystem.
Copy a FileSystem on a given Partition and Device to another Partition on a (possibly other) Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopyFileSystemJob : public Job
{

View File

@ -28,8 +28,8 @@ class Report;
class QString;
/** @brief Create a FileSystem.
@author vl@fidra.de
/** Create a FileSystem.
@author Volker Lanz <vl@fidra.de>
*/
class CreateFileSystemJob : public Job
{

View File

@ -29,8 +29,8 @@ class Report;
class QString;
/** @brief Create a Partition.
@author vl@fidra.de
/** Create a Partition.
@author Volker Lanz <vl@fidra.de>
*/
class CreatePartitionJob : public Job
{

View File

@ -28,8 +28,8 @@ class Report;
class QString;
/** @brief Create a PartitionTable.
@author vl@fidra.de
/** Create a PartitionTable.
@author Volker Lanz <vl@fidra.de>
*/
class CreatePartitionTableJob : public Job
{

View File

@ -29,11 +29,11 @@ class Report;
class QString;
/** @brief Delete a FileSystem.
/** Delete a FileSystem.
Delete and clobber the FileSystem on the given Partition on the given Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class DeleteFileSystemJob : public Job
{

View File

@ -29,8 +29,8 @@ class Report;
class QString;
/** @brief Delete a Partition.
@author vl@fidra.de
/** Delete a Partition.
@author Volker Lanz <vl@fidra.de>
*/
class DeletePartitionJob : public Job
{

View File

@ -35,14 +35,14 @@ class CopySource;
class CopyTarget;
class Report;
/** @brief Base class for all Jobs.
/** Base class for all Jobs.
Each Operation is made up of one or more Jobs. Usually, an Operation will run each Job it is
made up of and only complete successfully if each Job could be run without error. Jobs are
all-or-nothing and try to be as atomic as possible: A Job is either successfully run or not, there
is no case where a Job finishes with a warning.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class LIBPARTITIONMANAGERPRIVATE_EXPORT Job : public QObject
{

View File

@ -29,11 +29,11 @@ class Report;
class QString;
/** @brief Move a FileSystem.
/** Move a FileSystem.
Moves a FileSystem on a given Device and Partition to a new start sector.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class MoveFileSystemJob : public Job
{

View File

@ -29,12 +29,12 @@ class Report;
class QString;
/** @brief Resize a FileSystem.
/** Resize a FileSystem.
Resizes a FileSystem on a given Device and Partition to a new length. If the new length is -1, the
FileSystem is maximized to fill the entire Partition.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class ResizeFileSystemJob : public Job
{

View File

@ -29,11 +29,11 @@ class Partition;
class Device;
class Report;
/** @brief Restore a FileSystem.
/** Restore a FileSystem.
Restores a FileSystem from a file to a given Partition on a given Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class RestoreFileSystemJob : public Job
{

View File

@ -29,8 +29,8 @@ class Partition;
class Report;
class OperationStack;
/** @brief Set a FileSystem label.
@author vl@fidra.de
/** Set a FileSystem label.
@author Volker Lanz <vl@fidra.de>
*/
class SetFileSystemLabelJob : public Job
{

View File

@ -31,11 +31,11 @@ class Report;
class QString;
/** @brief Set a Partition's flags.
/** Set a Partition's flags.
Set the Partition flags for a given Partition on a given Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class SetPartFlagsJob : public Job
{

View File

@ -31,13 +31,13 @@ class Report;
class QString;
/** @brief Set a Partition's geometry.
/** Set a Partition's geometry.
Sets the geometry for a given Partition on a given Device to a new start sector and/or a new
length. This does not move the FileSystem, it only updates the partition table entry for the
Partition and is usually run together with MoveFileSystemJob or ResizeFileSystemJob for that reason.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class SetPartGeometryJob : public Job
{

View File

@ -29,11 +29,11 @@ class Partition;
class Device;
class Report;
/** @brief Securely delete and shred a FileSystem.
/** Securely delete and shred a FileSystem.
Shreds (overwrites with random data) a FileSystem on given Partition and Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class ShredFileSystemJob : public Job
{

View File

@ -29,8 +29,8 @@ class Partition;
class Device;
class BackupFileSystemJob;
/** @brief Back up a FileSystem.
@author vl@fidra.de
/** Back up a FileSystem.
@author Volker Lanz <vl@fidra.de>
*/
class BackupOperation : public Operation
{

View File

@ -30,8 +30,8 @@ class Device;
class CheckFileSystemJob;
class ResizeFileSystemJob;
/** @brief Check a Partition.
@author vl@fidra.de
/** Check a Partition.
@author Volker Lanz <vl@fidra.de>
*/
class CheckOperation : public Operation
{

View File

@ -35,12 +35,12 @@ class CheckFileSystemJob;
class CopyFileSystemJob;
class ResizeFileSystemJob;
/** @brief Copy a Partition.
/** Copy a Partition.
Copies a Partition from a given source Device to a Partition on a given target Device and handles overwriting
the target Partition in case that is required.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CopyOperation : public Operation
{

View File

@ -34,11 +34,11 @@ class DeleteFileSystemJob;
class CreateFileSystemJob;
class CheckFileSystemJob;
/** @brief Create a FileSystem.
/** Create a FileSystem.
Creates a FileSystem on a given Partition and Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class CreateFileSystemOperation : public Operation
{

View File

@ -31,8 +31,8 @@ class Device;
class CreatePartitionTableJob;
class PartitionTable;
/** @brief Create a PartitionTable.
@author vl@fidra.de
/** Create a PartitionTable.
@author Volker Lanz <vl@fidra.de>
*/
class CreatePartitionTableOperation : public Operation
{

View File

@ -32,8 +32,8 @@ class Partition;
class Job;
class DeletePartitionJob;
/** @brief Delete a Partition.
@author vl@fidra.de
/** Delete a Partition.
@author Volker Lanz <vl@fidra.de>
*/
class DeleteOperation : public Operation
{

View File

@ -33,11 +33,11 @@ class CreateFileSystemJob;
class SetFileSystemLabelJob;
class CheckFileSystemJob;
/** @brief Create a Partition.
/** Create a Partition.
Creates the given Partition on the given Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class NewOperation : public Operation
{

View File

@ -35,7 +35,7 @@ class Report;
class QString;
class QIcon;
/** @brief Base class of all Operations.
/** Base class of all Operations.
An Operation serves two purposes: It is responsible for modifying the device preview to show the
user a state as if the Operation had already been applied and it is made up of Jobs to actually
@ -68,7 +68,7 @@ class QIcon;
</li>
</ol>
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class Operation : public QObject
{
@ -102,8 +102,8 @@ class Operation : public QObject
public:
virtual QString iconName() const = 0; /**< @return name of the icon for the Operation */
virtual QString description() const = 0; /**< @return the Operation's description */
virtual void preview() = 0; /**< @brief Apply the Operation to the current preview */
virtual void undo() = 0; /**< @brief Undo applying the Operation to the current preview */
virtual void preview() = 0; /**< Apply the Operation to the current preview */
virtual void undo() = 0; /**< Undo applying the Operation to the current preview */
virtual bool execute(Report& parent);
virtual OperationStatus status() const { return m_Status; } /**< @return the current status */

View File

@ -40,12 +40,12 @@ class MoveFileSystemJob;
class ResizeFileSystemJob;
class CheckFileSystemJob;
/** @brief Resizes a Partition and FileSystem.
/** Resizes a Partition and FileSystem.
Resize the given Partition and its FileSystem on the given Device so they start with the
given new start sector and end with the given new last sector.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class ResizeOperation : public Operation
{

View File

@ -36,12 +36,12 @@ class RestoreFileSystemJob;
class CheckFileSystemJob;
class ResizeFileSystemJob;
/** @brief Restore a Partition.
/** Restore a Partition.
Restores the FileSystem from a file to the given Partition on the given Device, handling overwriting
a previous Partition in case that is necessary.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class RestoreOperation : public Operation
{

View File

@ -30,11 +30,11 @@ class Partition;
class SetFileSystemLabelJob;
/** @brief Set a FileSystem label.
/** Set a FileSystem label.
Sets the FileSystem label for the given Partition.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class SetFileSystemLabelOperation : public Operation
{

View File

@ -33,11 +33,11 @@ class Partition;
class SetPartFlagsJob;
/** @brief Set Partition flags.
/** Set Partition flags.
Sets the Partition flags for the given Partition on the given Device.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class SetPartFlagsOperation : public Operation
{

View File

@ -30,9 +30,9 @@ class Device;
class KPluginFactory;
class QString;
/** @brief Dummy backend plugin that doesn't really do anything.
/** Dummy backend plugin that doesn't really do anything.
@author vl@fidra.de
@author Volker Lanz <vl@fidra.de>
*/
class DummyBackend : public CoreBackend
{

Some files were not shown because too many files have changed in this diff Show More