From d058abce6e68b3ac40d592062992a07f52845b51 Mon Sep 17 00:00:00 2001 From: Volker Lanz Date: Tue, 18 May 2010 22:27:30 +0000 Subject: [PATCH] doxygen updates svn path=/trunk/extragear/sysadmin/partitionmanager/; revision=1128312 --- TODO | 6 ++ src/backend/corebackend.h | 77 +++++++++++++++++++++++- src/backend/corebackenddevice.h | 53 ++++++++++++++++ src/backend/corebackendmanager.h | 31 ++++++++++ src/backend/corebackendpartition.h | 11 ++++ src/backend/corebackendpartitiontable.h | 69 +++++++++++++++++++++ src/core/copysource.h | 4 +- src/core/copysourcedevice.h | 4 +- src/core/copysourcefile.h | 4 +- src/core/copysourceshred.h | 4 +- src/core/copytarget.h | 4 +- src/core/copytargetdevice.h | 4 +- src/core/copytargetfile.h | 4 +- src/core/device.h | 4 +- src/core/devicescanner.h | 4 +- src/core/operationrunner.h | 4 +- src/core/operationstack.h | 4 +- src/core/partition.h | 4 +- src/core/partitionnode.h | 4 +- src/core/partitionrole.h | 4 +- src/core/partitiontable.h | 4 +- src/fs/btrfs.h | 4 +- src/fs/ext2.h | 4 +- src/fs/ext3.h | 4 +- src/fs/ext4.h | 4 +- src/fs/extended.h | 4 +- src/fs/fat16.h | 4 +- src/fs/fat32.h | 4 +- src/fs/filesystem.h | 4 +- src/fs/filesystemfactory.h | 4 +- src/fs/hfs.h | 4 +- src/fs/hfsplus.h | 4 +- src/fs/hpfs.h | 4 +- src/fs/jfs.h | 4 +- src/fs/linuxswap.h | 4 +- src/fs/luks.h | 4 +- src/fs/ntfs.h | 4 +- src/fs/ocfs2.h | 4 +- src/fs/reiser4.h | 4 +- src/fs/reiserfs.h | 4 +- src/fs/ufs.h | 4 +- src/fs/unformatted.h | 4 +- src/fs/unknown.h | 4 +- src/fs/xfs.h | 4 +- src/fs/zfs.h | 4 +- src/gui/applyprogressdetailswidget.h | 4 +- src/gui/applyprogressdialog.h | 4 +- src/gui/applyprogressdialogwidget.h | 4 +- src/gui/devicepropsdialog.h | 4 +- src/gui/devicepropswidget.h | 4 +- src/gui/filesystemsupportdialog.h | 4 +- src/gui/infopane.h | 4 +- src/gui/insertdialog.h | 4 +- src/gui/listdevices.h | 4 +- src/gui/listoperations.h | 4 +- src/gui/mainwindow.h | 4 +- src/gui/newdialog.h | 4 +- src/gui/partitionmanagerwidget.h | 4 +- src/gui/partpropsdialog.h | 4 +- src/gui/partpropswidget.h | 4 +- src/gui/partresizerwidget.h | 4 +- src/gui/parttablewidget.h | 4 +- src/gui/partwidget.h | 4 +- src/gui/partwidgetbase.h | 4 +- src/gui/resizedialog.h | 4 +- src/gui/sizedetailswidget.h | 4 +- src/gui/sizedialogbase.h | 4 +- src/gui/sizedialogwidget.h | 4 +- src/gui/smartdialog.h | 4 +- src/gui/smartdialogwidget.h | 4 +- src/gui/treelog.h | 4 +- src/jobs/backupfilesystemjob.h | 4 +- src/jobs/checkfilesystemjob.h | 4 +- src/jobs/copyfilesystemjob.h | 4 +- src/jobs/createfilesystemjob.h | 4 +- src/jobs/createpartitionjob.h | 4 +- src/jobs/createpartitiontablejob.h | 4 +- src/jobs/deletefilesystemjob.h | 4 +- src/jobs/deletepartitionjob.h | 4 +- src/jobs/job.h | 4 +- src/jobs/movefilesystemjob.h | 4 +- src/jobs/resizefilesystemjob.h | 4 +- src/jobs/restorefilesystemjob.h | 4 +- src/jobs/setfilesystemlabeljob.h | 4 +- src/jobs/setpartflagsjob.h | 4 +- src/jobs/setpartgeometryjob.h | 4 +- src/jobs/shredfilesystemjob.h | 4 +- src/ops/backupoperation.h | 4 +- src/ops/checkoperation.h | 4 +- src/ops/copyoperation.h | 4 +- src/ops/createfilesystemoperation.h | 4 +- src/ops/createpartitiontableoperation.h | 4 +- src/ops/deleteoperation.h | 4 +- src/ops/newoperation.h | 4 +- src/ops/operation.h | 8 +-- src/ops/resizeoperation.h | 4 +- src/ops/restoreoperation.h | 4 +- src/ops/setfilesystemlabeloperation.h | 4 +- src/ops/setpartflagsoperation.h | 4 +- src/plugins/dummy/dummybackend.h | 4 +- src/plugins/libparted/libpartedbackend.h | 4 +- src/util/capacity.h | 4 +- src/util/externalcommand.h | 4 +- src/util/globallog.h | 4 +- src/util/report.h | 4 +- 105 files changed, 445 insertions(+), 202 deletions(-) diff --git a/TODO b/TODO index 36c9f6f..1622aca 100644 --- a/TODO +++ b/TODO @@ -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: diff --git a/src/backend/corebackend.h b/src/backend/corebackend.h index 5af1f23..86ac73c 100644 --- a/src/backend/corebackend.h +++ b/src/backend/corebackend.h @@ -35,6 +35,11 @@ class KAboutData; class QString; +/** + * Interface class for backend plugins. + * @author Volker Lanz + */ + 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 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: diff --git a/src/backend/corebackenddevice.h b/src/backend/corebackenddevice.h index d240a2f..bc08df1 100644 --- a/src/backend/corebackenddevice.h +++ b/src/backend/corebackenddevice.h @@ -32,6 +32,10 @@ class Partition; class PartitionTable; class Report; +/** + * Interface class representing a device in the backend plugin. + * @author Volker Lanz + */ 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: diff --git a/src/backend/corebackendmanager.h b/src/backend/corebackendmanager.h index d8017d7..133b861 100644 --- a/src/backend/corebackendmanager.h +++ b/src/backend/corebackendmanager.h @@ -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 + */ 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: diff --git a/src/backend/corebackendpartition.h b/src/backend/corebackendpartition.h index 8d27842..689bc09 100644 --- a/src/backend/corebackendpartition.h +++ b/src/backend/corebackendpartition.h @@ -27,6 +27,10 @@ class Report; +/** + * Represents a partition in the backend plugin. + * @author Volker Lanz + */ 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; }; diff --git a/src/backend/corebackendpartitiontable.h b/src/backend/corebackendpartitiontable.h index 01b7021..552537b 100644 --- a/src/backend/corebackendpartitiontable.h +++ b/src/backend/corebackendpartitiontable.h @@ -26,29 +26,98 @@ #include "fs/filesystem.h" #include +#include class CoreBackendPartition; class Report; class Partition; +/** + * Interface class to represent a partition table in the backend. + * @author Volker Lanz + */ 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; }; diff --git a/src/core/copysource.h b/src/core/copysource.h index fe2cab4..aba00a3 100644 --- a/src/core/copysource.h +++ b/src/core/copysource.h @@ -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 */ class CopySource { diff --git a/src/core/copysourcedevice.h b/src/core/copysourcedevice.h index e0e6feb..51810fb 100644 --- a/src/core/copysourcedevice.h +++ b/src/core/copysourcedevice.h @@ -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 */ class CopySourceDevice : public CopySource { diff --git a/src/core/copysourcefile.h b/src/core/copysourcefile.h index 2244a52..411987d 100644 --- a/src/core/copysourcefile.h +++ b/src/core/copysourcefile.h @@ -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 */ class CopySourceFile : public CopySource { diff --git a/src/core/copysourceshred.h b/src/core/copysourceshred.h index 36c29fc..a874f68 100644 --- a/src/core/copysourceshred.h +++ b/src/core/copysourceshred.h @@ -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 */ class CopySourceShred : public CopySource { diff --git a/src/core/copytarget.h b/src/core/copytarget.h index d1cb807..2c269db 100644 --- a/src/core/copytarget.h +++ b/src/core/copytarget.h @@ -24,13 +24,13 @@ #include -/** @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 */ class CopyTarget { diff --git a/src/core/copytargetdevice.h b/src/core/copytargetdevice.h index 8fadb0a..2f61ac0 100644 --- a/src/core/copytargetdevice.h +++ b/src/core/copytargetdevice.h @@ -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 */ class CopyTargetDevice : public CopyTarget { diff --git a/src/core/copytargetfile.h b/src/core/copytargetfile.h index 3448cb4..a35472f 100644 --- a/src/core/copytargetfile.h +++ b/src/core/copytargetfile.h @@ -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 */ class CopyTargetFile : public CopyTarget { diff --git a/src/core/device.h b/src/core/device.h index 48a4e13..8d48315 100644 --- a/src/core/device.h +++ b/src/core/device.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT Device : public QObject { diff --git a/src/core/devicescanner.h b/src/core/devicescanner.h index 26e6621..c3625cf 100644 --- a/src/core/devicescanner.h +++ b/src/core/devicescanner.h @@ -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 */ class DeviceScanner : public QThread { diff --git a/src/core/operationrunner.h b/src/core/operationrunner.h index ded8dd9..439a36e 100644 --- a/src/core/operationrunner.h +++ b/src/core/operationrunner.h @@ -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 */ class OperationRunner : public QThread { diff --git a/src/core/operationstack.h b/src/core/operationstack.h index 6fecb18..865073d 100644 --- a/src/core/operationstack.h +++ b/src/core/operationstack.h @@ -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 */ class OperationStack : public QObject { diff --git a/src/core/partition.h b/src/core/partition.h index ae317ab..a35c5e5 100644 --- a/src/core/partition.h +++ b/src/core/partition.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT Partition : public PartitionNode { diff --git a/src/core/partitionnode.h b/src/core/partitionnode.h index b3a4f2a..eaf984c 100644 --- a/src/core/partitionnode.h +++ b/src/core/partitionnode.h @@ -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 */ class PartitionNode : public QObject { diff --git a/src/core/partitionrole.h b/src/core/partitionrole.h index eba7e38..ad80df9 100644 --- a/src/core/partitionrole.h +++ b/src/core/partitionrole.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT PartitionRole { diff --git a/src/core/partitiontable.h b/src/core/partitiontable.h index 6013c1d..be1b13f 100644 --- a/src/core/partitiontable.h +++ b/src/core/partitiontable.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT PartitionTable : public PartitionNode { diff --git a/src/fs/btrfs.h b/src/fs/btrfs.h index cd7b079..abec65e 100644 --- a/src/fs/btrfs.h +++ b/src/fs/btrfs.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief A btrfs file system. - @author vl@fidra.de + /** A btrfs file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT btrfs : public FileSystem { diff --git a/src/fs/ext2.h b/src/fs/ext2.h index ab9f614..e500ba5 100644 --- a/src/fs/ext2.h +++ b/src/fs/ext2.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief An ext2 file system. - @author vl@fidra.de + /** An ext2 file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ext2 : public FileSystem { diff --git a/src/fs/ext3.h b/src/fs/ext3.h index b2bdd37..443e2e7 100644 --- a/src/fs/ext3.h +++ b/src/fs/ext3.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ext3 : public ext2 { diff --git a/src/fs/ext4.h b/src/fs/ext4.h index 429a51b..6946a83 100644 --- a/src/fs/ext4.h +++ b/src/fs/ext4.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ext4 : public ext2 { diff --git a/src/fs/extended.h b/src/fs/extended.h index 07a9ecb..65ebe9d 100644 --- a/src/fs/extended.h +++ b/src/fs/extended.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT extended : public FileSystem diff --git a/src/fs/fat16.h b/src/fs/fat16.h index de78fe1..bc89dfc 100644 --- a/src/fs/fat16.h +++ b/src/fs/fat16.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief A fat16 file system. - @author vl@fidra.de + /** A fat16 file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT fat16 : public FileSystem { diff --git a/src/fs/fat32.h b/src/fs/fat32.h index aecdcfc..35a501d 100644 --- a/src/fs/fat32.h +++ b/src/fs/fat32.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT fat32 : public fat16 { diff --git a/src/fs/filesystem.h b/src/fs/filesystem.h index 98c7a7c..571849f 100644 --- a/src/fs/filesystem.h +++ b/src/fs/filesystem.h @@ -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 */ class FileSystem { diff --git a/src/fs/filesystemfactory.h b/src/fs/filesystemfactory.h index dba9dfa..bda8ca5 100644 --- a/src/fs/filesystemfactory.h +++ b/src/fs/filesystemfactory.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT FileSystemFactory { diff --git a/src/fs/hfs.h b/src/fs/hfs.h index 0e86bf6..7503f38 100644 --- a/src/fs/hfs.h +++ b/src/fs/hfs.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief An hfs file system. - @author vl@fidra.de + /** An hfs file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT hfs : public FileSystem { diff --git a/src/fs/hfsplus.h b/src/fs/hfsplus.h index 2bf742e..8e3833b 100644 --- a/src/fs/hfsplus.h +++ b/src/fs/hfsplus.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief An hfsplus file system. - @author vl@fidra.de + /** An hfsplus file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT hfsplus : public FileSystem { diff --git a/src/fs/hpfs.h b/src/fs/hpfs.h index 135879c..bb0d409 100644 --- a/src/fs/hpfs.h +++ b/src/fs/hpfs.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief A hpfs file system. - @author vl@fidra.de + /** A hpfs file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT hpfs : public FileSystem { diff --git a/src/fs/jfs.h b/src/fs/jfs.h index eeb665d..5845986 100644 --- a/src/fs/jfs.h +++ b/src/fs/jfs.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief A JFS file system. - @author vl@fidra.de + /** A JFS file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT jfs : public FileSystem { diff --git a/src/fs/linuxswap.h b/src/fs/linuxswap.h index a2b83c8..054d1f4 100644 --- a/src/fs/linuxswap.h +++ b/src/fs/linuxswap.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT linuxswap : public FileSystem { diff --git a/src/fs/luks.h b/src/fs/luks.h index c93e6bc..b517c7c 100644 --- a/src/fs/luks.h +++ b/src/fs/luks.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT luks : public FileSystem { diff --git a/src/fs/ntfs.h b/src/fs/ntfs.h index 3bd689b..14a3ee7 100644 --- a/src/fs/ntfs.h +++ b/src/fs/ntfs.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief An NTFS file system. - @author vl@fidra.de + /** An NTFS file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ntfs : public FileSystem { diff --git a/src/fs/ocfs2.h b/src/fs/ocfs2.h index e03a89a..dd4bfe7 100644 --- a/src/fs/ocfs2.h +++ b/src/fs/ocfs2.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief A ocfs2 file system. - @author vl@fidra.de + /** A ocfs2 file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ocfs2 : public FileSystem { diff --git a/src/fs/reiser4.h b/src/fs/reiser4.h index 87c62c3..13a1c3c 100644 --- a/src/fs/reiser4.h +++ b/src/fs/reiser4.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief A Reiser4 file system. - @author vl@fidra.de + /** A Reiser4 file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT reiser4 : public FileSystem { diff --git a/src/fs/reiserfs.h b/src/fs/reiserfs.h index 8335fd6..4661fd9 100644 --- a/src/fs/reiserfs.h +++ b/src/fs/reiserfs.h @@ -35,8 +35,8 @@ class QString; namespace FS { - /** @brief A ReiserFS file system. - @author vl@fidra.de + /** A ReiserFS file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT reiserfs : public FileSystem { diff --git a/src/fs/ufs.h b/src/fs/ufs.h index f25fa77..cfdd380 100644 --- a/src/fs/ufs.h +++ b/src/fs/ufs.h @@ -31,8 +31,8 @@ class QString; namespace FS { - /** @brief A UFS file system. - @author vl@fidra.de + /** A UFS file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ufs : public FileSystem { diff --git a/src/fs/unformatted.h b/src/fs/unformatted.h index 1b2e57a..7cde3f5 100644 --- a/src/fs/unformatted.h +++ b/src/fs/unformatted.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT unformatted : public FileSystem { diff --git a/src/fs/unknown.h b/src/fs/unknown.h index 432d4a1..95acaa4 100644 --- a/src/fs/unknown.h +++ b/src/fs/unknown.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT unknown : public FileSystem { diff --git a/src/fs/xfs.h b/src/fs/xfs.h index 925093f..8c4b71e 100644 --- a/src/fs/xfs.h +++ b/src/fs/xfs.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief An XFS file system. - @author vl@fidra.de + /** An XFS file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT xfs : public FileSystem { diff --git a/src/fs/zfs.h b/src/fs/zfs.h index 7844e83..4999ebe 100644 --- a/src/fs/zfs.h +++ b/src/fs/zfs.h @@ -33,8 +33,8 @@ class QString; namespace FS { - /** @brief A zfs file system. - @author vl@fidra.de + /** A zfs file system. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT zfs : public FileSystem { diff --git a/src/gui/applyprogressdetailswidget.h b/src/gui/applyprogressdetailswidget.h index 15ce91d..605fd8d 100644 --- a/src/gui/applyprogressdetailswidget.h +++ b/src/gui/applyprogressdetailswidget.h @@ -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 */ class ApplyProgressDetailsWidget : public QWidget, public Ui::ApplyProgressDetailsWidgetBase { diff --git a/src/gui/applyprogressdialog.h b/src/gui/applyprogressdialog.h index 460531f..4d58ca4 100644 --- a/src/gui/applyprogressdialog.h +++ b/src/gui/applyprogressdialog.h @@ -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 */ class ApplyProgressDialog : public KDialog { diff --git a/src/gui/applyprogressdialogwidget.h b/src/gui/applyprogressdialogwidget.h index 1df70ba..0f0bcd4 100644 --- a/src/gui/applyprogressdialogwidget.h +++ b/src/gui/applyprogressdialogwidget.h @@ -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 */ class ApplyProgressDialogWidget : public QWidget, public Ui::ApplyProgressDialogWidgetBase { diff --git a/src/gui/devicepropsdialog.h b/src/gui/devicepropsdialog.h index a169955..d7f0898 100644 --- a/src/gui/devicepropsdialog.h +++ b/src/gui/devicepropsdialog.h @@ -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 */ class DevicePropsDialog : public KDialog { diff --git a/src/gui/devicepropswidget.h b/src/gui/devicepropswidget.h index 685c4c7..f5b7e9f 100644 --- a/src/gui/devicepropswidget.h +++ b/src/gui/devicepropswidget.h @@ -25,8 +25,8 @@ class PartTableWidget; -/** @brief Central widget in the DevicePropsDialog. - @author vl@fidra.de +/** Central widget in the DevicePropsDialog. + @author Volker Lanz */ class DevicePropsWidget : public QWidget, public Ui::DevicePropsWidgetBase { diff --git a/src/gui/filesystemsupportdialog.h b/src/gui/filesystemsupportdialog.h index 612bfc2..e22e167 100644 --- a/src/gui/filesystemsupportdialog.h +++ b/src/gui/filesystemsupportdialog.h @@ -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 */ class FileSystemSupportDialog : public KDialog { diff --git a/src/gui/infopane.h b/src/gui/infopane.h index 4e268c5..f2b4d77 100644 --- a/src/gui/infopane.h +++ b/src/gui/infopane.h @@ -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 */ class InfoPane : public QWidget { diff --git a/src/gui/insertdialog.h b/src/gui/insertdialog.h index bb9c2fe..dd1753b 100644 --- a/src/gui/insertdialog.h +++ b/src/gui/insertdialog.h @@ -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 */ class InsertDialog : public SizeDialogBase { diff --git a/src/gui/listdevices.h b/src/gui/listdevices.h index e431697..b59ee13 100644 --- a/src/gui/listdevices.h +++ b/src/gui/listdevices.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ListDevices : public QWidget, public Ui::ListDevicesBase { diff --git a/src/gui/listoperations.h b/src/gui/listoperations.h index ebf9170..5bd8d4f 100644 --- a/src/gui/listoperations.h +++ b/src/gui/listoperations.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ListOperations : public QWidget, public Ui::ListOperationsBase { diff --git a/src/gui/mainwindow.h b/src/gui/mainwindow.h index 73d0b1f..23bde1e 100644 --- a/src/gui/mainwindow.h +++ b/src/gui/mainwindow.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT MainWindow : public KXmlGuiWindow, public Ui::MainWindowBase { diff --git a/src/gui/newdialog.h b/src/gui/newdialog.h index 2dc515a..db3b863 100644 --- a/src/gui/newdialog.h +++ b/src/gui/newdialog.h @@ -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 */ class NewDialog : public SizeDialogBase { diff --git a/src/gui/partitionmanagerwidget.h b/src/gui/partitionmanagerwidget.h index 5c2062a..c6a33de 100644 --- a/src/gui/partitionmanagerwidget.h +++ b/src/gui/partitionmanagerwidget.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT PartitionManagerWidget : public QWidget, Ui::PartitionManagerWidgetBase { diff --git a/src/gui/partpropsdialog.h b/src/gui/partpropsdialog.h index 246ca57..fb11244 100644 --- a/src/gui/partpropsdialog.h +++ b/src/gui/partpropsdialog.h @@ -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 */ class PartPropsDialog : public KDialog { diff --git a/src/gui/partpropswidget.h b/src/gui/partpropswidget.h index 41b988f..4898a79 100644 --- a/src/gui/partpropswidget.h +++ b/src/gui/partpropswidget.h @@ -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 */ class PartPropsWidget : public QWidget, public Ui::PartPropsWidgetBase { diff --git a/src/gui/partresizerwidget.h b/src/gui/partresizerwidget.h index adc8162..b4f5af2 100644 --- a/src/gui/partresizerwidget.h +++ b/src/gui/partresizerwidget.h @@ -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 */ class PartResizerWidget : public QWidget { diff --git a/src/gui/parttablewidget.h b/src/gui/parttablewidget.h index a18c611..989d700 100644 --- a/src/gui/parttablewidget.h +++ b/src/gui/parttablewidget.h @@ -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 */ class PartTableWidget : public PartWidgetBase { diff --git a/src/gui/partwidget.h b/src/gui/partwidget.h index c510c91..226903f 100644 --- a/src/gui/partwidget.h +++ b/src/gui/partwidget.h @@ -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 */ class PartWidget : public PartWidgetBase { diff --git a/src/gui/partwidgetbase.h b/src/gui/partwidgetbase.h index c05e764..24408db 100644 --- a/src/gui/partwidgetbase.h +++ b/src/gui/partwidgetbase.h @@ -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 */ class PartWidgetBase : public QWidget { diff --git a/src/gui/resizedialog.h b/src/gui/resizedialog.h index cb979a2..986ac98 100644 --- a/src/gui/resizedialog.h +++ b/src/gui/resizedialog.h @@ -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 */ class ResizeDialog : public SizeDialogBase { diff --git a/src/gui/sizedetailswidget.h b/src/gui/sizedetailswidget.h index f9673fa..d0fdff8 100644 --- a/src/gui/sizedetailswidget.h +++ b/src/gui/sizedetailswidget.h @@ -26,8 +26,8 @@ #include #include -/** @brief Details widget for the SizeDetailsBase - @author vl@fidra.de +/** Details widget for the SizeDetailsBase + @author Volker Lanz */ class SizeDetailsWidget : public QWidget, public Ui::SizeDetailsWidgetBase { diff --git a/src/gui/sizedialogbase.h b/src/gui/sizedialogbase.h index a0f5acd..2d5b49b 100644 --- a/src/gui/sizedialogbase.h +++ b/src/gui/sizedialogbase.h @@ -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 */ class SizeDialogBase : public KDialog { diff --git a/src/gui/sizedialogwidget.h b/src/gui/sizedialogwidget.h index 5796e6b..b281b08 100644 --- a/src/gui/sizedialogwidget.h +++ b/src/gui/sizedialogwidget.h @@ -26,8 +26,8 @@ #include #include -/** @brief Central widget for the SizeDialogBase - @author vl@fidra.de +/** Central widget for the SizeDialogBase + @author Volker Lanz */ class SizeDialogWidget : public QWidget, public Ui::SizeDialogWidgetBase { diff --git a/src/gui/smartdialog.h b/src/gui/smartdialog.h index cba71e1..4149c6e 100644 --- a/src/gui/smartdialog.h +++ b/src/gui/smartdialog.h @@ -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 */ class SmartDialog : public KDialog { diff --git a/src/gui/smartdialogwidget.h b/src/gui/smartdialogwidget.h index 338b941..f512cd5 100644 --- a/src/gui/smartdialogwidget.h +++ b/src/gui/smartdialogwidget.h @@ -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 */ class SmartDialogWidget : public QWidget, public Ui::SmartDialogWidgetBase { diff --git a/src/gui/treelog.h b/src/gui/treelog.h index ac5eeed..1aed85b 100644 --- a/src/gui/treelog.h +++ b/src/gui/treelog.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT TreeLog: public QWidget, public Ui::TreeLogBase { diff --git a/src/jobs/backupfilesystemjob.h b/src/jobs/backupfilesystemjob.h index 3c55fe8..9e87dad 100644 --- a/src/jobs/backupfilesystemjob.h +++ b/src/jobs/backupfilesystemjob.h @@ -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 */ class BackupFileSystemJob : public Job { diff --git a/src/jobs/checkfilesystemjob.h b/src/jobs/checkfilesystemjob.h index 2cf253d..4ce40ad 100644 --- a/src/jobs/checkfilesystemjob.h +++ b/src/jobs/checkfilesystemjob.h @@ -28,8 +28,8 @@ class Report; class QString; -/** @brief Check a FileSystem. - @author vl@fidra.de +/** Check a FileSystem. + @author Volker Lanz */ class CheckFileSystemJob : public Job { diff --git a/src/jobs/copyfilesystemjob.h b/src/jobs/copyfilesystemjob.h index 378c9a4..6c4af33 100644 --- a/src/jobs/copyfilesystemjob.h +++ b/src/jobs/copyfilesystemjob.h @@ -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 */ class CopyFileSystemJob : public Job { diff --git a/src/jobs/createfilesystemjob.h b/src/jobs/createfilesystemjob.h index b29f4ae..80ab594 100644 --- a/src/jobs/createfilesystemjob.h +++ b/src/jobs/createfilesystemjob.h @@ -28,8 +28,8 @@ class Report; class QString; -/** @brief Create a FileSystem. - @author vl@fidra.de +/** Create a FileSystem. + @author Volker Lanz */ class CreateFileSystemJob : public Job { diff --git a/src/jobs/createpartitionjob.h b/src/jobs/createpartitionjob.h index 128b4be..4a389dd 100644 --- a/src/jobs/createpartitionjob.h +++ b/src/jobs/createpartitionjob.h @@ -29,8 +29,8 @@ class Report; class QString; -/** @brief Create a Partition. - @author vl@fidra.de +/** Create a Partition. + @author Volker Lanz */ class CreatePartitionJob : public Job { diff --git a/src/jobs/createpartitiontablejob.h b/src/jobs/createpartitiontablejob.h index 628931f..837f89f 100644 --- a/src/jobs/createpartitiontablejob.h +++ b/src/jobs/createpartitiontablejob.h @@ -28,8 +28,8 @@ class Report; class QString; -/** @brief Create a PartitionTable. - @author vl@fidra.de +/** Create a PartitionTable. + @author Volker Lanz */ class CreatePartitionTableJob : public Job { diff --git a/src/jobs/deletefilesystemjob.h b/src/jobs/deletefilesystemjob.h index 0969e82..6b01e51 100644 --- a/src/jobs/deletefilesystemjob.h +++ b/src/jobs/deletefilesystemjob.h @@ -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 */ class DeleteFileSystemJob : public Job { diff --git a/src/jobs/deletepartitionjob.h b/src/jobs/deletepartitionjob.h index 532f2f9..7f702b4 100644 --- a/src/jobs/deletepartitionjob.h +++ b/src/jobs/deletepartitionjob.h @@ -29,8 +29,8 @@ class Report; class QString; -/** @brief Delete a Partition. - @author vl@fidra.de +/** Delete a Partition. + @author Volker Lanz */ class DeletePartitionJob : public Job { diff --git a/src/jobs/job.h b/src/jobs/job.h index e8d3f8d..4ce07c7 100644 --- a/src/jobs/job.h +++ b/src/jobs/job.h @@ -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 */ class LIBPARTITIONMANAGERPRIVATE_EXPORT Job : public QObject { diff --git a/src/jobs/movefilesystemjob.h b/src/jobs/movefilesystemjob.h index 22efea5..fe965f9 100644 --- a/src/jobs/movefilesystemjob.h +++ b/src/jobs/movefilesystemjob.h @@ -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 */ class MoveFileSystemJob : public Job { diff --git a/src/jobs/resizefilesystemjob.h b/src/jobs/resizefilesystemjob.h index 3233fe8..a83bbba 100644 --- a/src/jobs/resizefilesystemjob.h +++ b/src/jobs/resizefilesystemjob.h @@ -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 */ class ResizeFileSystemJob : public Job { diff --git a/src/jobs/restorefilesystemjob.h b/src/jobs/restorefilesystemjob.h index c8cac2f..2078261 100644 --- a/src/jobs/restorefilesystemjob.h +++ b/src/jobs/restorefilesystemjob.h @@ -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 */ class RestoreFileSystemJob : public Job { diff --git a/src/jobs/setfilesystemlabeljob.h b/src/jobs/setfilesystemlabeljob.h index f826373..15b7b8b 100644 --- a/src/jobs/setfilesystemlabeljob.h +++ b/src/jobs/setfilesystemlabeljob.h @@ -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 */ class SetFileSystemLabelJob : public Job { diff --git a/src/jobs/setpartflagsjob.h b/src/jobs/setpartflagsjob.h index bd6b005..baebf30 100644 --- a/src/jobs/setpartflagsjob.h +++ b/src/jobs/setpartflagsjob.h @@ -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 */ class SetPartFlagsJob : public Job { diff --git a/src/jobs/setpartgeometryjob.h b/src/jobs/setpartgeometryjob.h index 9e2f6c2..870917c 100644 --- a/src/jobs/setpartgeometryjob.h +++ b/src/jobs/setpartgeometryjob.h @@ -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 */ class SetPartGeometryJob : public Job { diff --git a/src/jobs/shredfilesystemjob.h b/src/jobs/shredfilesystemjob.h index 497b36d..5e0f88b 100644 --- a/src/jobs/shredfilesystemjob.h +++ b/src/jobs/shredfilesystemjob.h @@ -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 */ class ShredFileSystemJob : public Job { diff --git a/src/ops/backupoperation.h b/src/ops/backupoperation.h index ba6f9f3..945029e 100644 --- a/src/ops/backupoperation.h +++ b/src/ops/backupoperation.h @@ -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 */ class BackupOperation : public Operation { diff --git a/src/ops/checkoperation.h b/src/ops/checkoperation.h index 8e05347..d8c11c8 100644 --- a/src/ops/checkoperation.h +++ b/src/ops/checkoperation.h @@ -30,8 +30,8 @@ class Device; class CheckFileSystemJob; class ResizeFileSystemJob; -/** @brief Check a Partition. - @author vl@fidra.de +/** Check a Partition. + @author Volker Lanz */ class CheckOperation : public Operation { diff --git a/src/ops/copyoperation.h b/src/ops/copyoperation.h index 456d249..75ce7fc 100644 --- a/src/ops/copyoperation.h +++ b/src/ops/copyoperation.h @@ -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 */ class CopyOperation : public Operation { diff --git a/src/ops/createfilesystemoperation.h b/src/ops/createfilesystemoperation.h index e9d25ed..3ca22e4 100644 --- a/src/ops/createfilesystemoperation.h +++ b/src/ops/createfilesystemoperation.h @@ -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 */ class CreateFileSystemOperation : public Operation { diff --git a/src/ops/createpartitiontableoperation.h b/src/ops/createpartitiontableoperation.h index de36e8d..08020e6 100644 --- a/src/ops/createpartitiontableoperation.h +++ b/src/ops/createpartitiontableoperation.h @@ -31,8 +31,8 @@ class Device; class CreatePartitionTableJob; class PartitionTable; -/** @brief Create a PartitionTable. - @author vl@fidra.de +/** Create a PartitionTable. + @author Volker Lanz */ class CreatePartitionTableOperation : public Operation { diff --git a/src/ops/deleteoperation.h b/src/ops/deleteoperation.h index c6f74a0..25a1db6 100644 --- a/src/ops/deleteoperation.h +++ b/src/ops/deleteoperation.h @@ -32,8 +32,8 @@ class Partition; class Job; class DeletePartitionJob; -/** @brief Delete a Partition. - @author vl@fidra.de +/** Delete a Partition. + @author Volker Lanz */ class DeleteOperation : public Operation { diff --git a/src/ops/newoperation.h b/src/ops/newoperation.h index f0cf4b1..37f1ff6 100644 --- a/src/ops/newoperation.h +++ b/src/ops/newoperation.h @@ -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 */ class NewOperation : public Operation { diff --git a/src/ops/operation.h b/src/ops/operation.h index 077f273..39df6d6 100644 --- a/src/ops/operation.h +++ b/src/ops/operation.h @@ -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; - @author vl@fidra.de + @author Volker Lanz */ 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 */ diff --git a/src/ops/resizeoperation.h b/src/ops/resizeoperation.h index c35e022..e371c99 100644 --- a/src/ops/resizeoperation.h +++ b/src/ops/resizeoperation.h @@ -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 */ class ResizeOperation : public Operation { diff --git a/src/ops/restoreoperation.h b/src/ops/restoreoperation.h index 5af423a..0cb42ff 100644 --- a/src/ops/restoreoperation.h +++ b/src/ops/restoreoperation.h @@ -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 */ class RestoreOperation : public Operation { diff --git a/src/ops/setfilesystemlabeloperation.h b/src/ops/setfilesystemlabeloperation.h index f3e9ee1..0262787 100644 --- a/src/ops/setfilesystemlabeloperation.h +++ b/src/ops/setfilesystemlabeloperation.h @@ -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 */ class SetFileSystemLabelOperation : public Operation { diff --git a/src/ops/setpartflagsoperation.h b/src/ops/setpartflagsoperation.h index b7f5f5b..35d6a5c 100644 --- a/src/ops/setpartflagsoperation.h +++ b/src/ops/setpartflagsoperation.h @@ -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 */ class SetPartFlagsOperation : public Operation { diff --git a/src/plugins/dummy/dummybackend.h b/src/plugins/dummy/dummybackend.h index ab1ee62..9c61021 100644 --- a/src/plugins/dummy/dummybackend.h +++ b/src/plugins/dummy/dummybackend.h @@ -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 */ class DummyBackend : public CoreBackend { diff --git a/src/plugins/libparted/libpartedbackend.h b/src/plugins/libparted/libpartedbackend.h index 53e56d7..48cd344 100644 --- a/src/plugins/libparted/libpartedbackend.h +++ b/src/plugins/libparted/libpartedbackend.h @@ -42,9 +42,9 @@ class Device; class KPluginFactory; class QString; -/** @brief Backend plugin for libparted. +/** Backend plugin for libparted. - @author vl@fidra.de + @author Volker Lanz */ class LibPartedBackend : public CoreBackend { diff --git a/src/util/capacity.h b/src/util/capacity.h index adcc426..2683207 100644 --- a/src/util/capacity.h +++ b/src/util/capacity.h @@ -26,12 +26,12 @@ class Device; #include -/** @brief Represent any kind of capacity. +/** Represent any kind of capacity. Any kind of capacity that can be expressed in units of Byte, KiB, MiB and so on. Also prints capacities in nicely formatted ways. - @author vl@fidra.de + @author Volker Lanz */ class Capacity { diff --git a/src/util/externalcommand.h b/src/util/externalcommand.h index be53ccd..6ff2faa 100644 --- a/src/util/externalcommand.h +++ b/src/util/externalcommand.h @@ -30,11 +30,11 @@ class Report; -/** @brief An external command. +/** An external command. Runs an external command as a child process. - @author vl@fidra.de + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT ExternalCommand : public QProcess { diff --git a/src/util/globallog.h b/src/util/globallog.h index e188784..ea62012 100644 --- a/src/util/globallog.h +++ b/src/util/globallog.h @@ -48,8 +48,8 @@ class LIBPARTITIONMANAGERPRIVATE_EXPORT Log Level level; }; -/** @brief Global logging. - @author vl@fidra.de +/** Global logging. + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT GlobalLog : public QObject { diff --git a/src/util/report.h b/src/util/report.h index 83bc390..8afb253 100644 --- a/src/util/report.h +++ b/src/util/report.h @@ -30,11 +30,11 @@ class ReportLine; -/** @brief Report details about running Operations and Jobs. +/** Report details about running Operations and Jobs. Gather information for the report shown in the ProgressDialog's detail view. - @author vl@fidra.de + @author Volker Lanz */ class LIBPARTITIONMANAGERPRIVATE_EXPORT Report : public QObject {