Refactor documentation comments to use /// Doxygen style for consistency across export and import classes.

Author: przemek83

include/eible/ExportData.h

@@ -8,22 +8,18 @@ class QAbstractItemView;
 class QAbstractItemModel;
 class QIODevice;
 
-/**
- * @class ExportData
- * @brief Base class for exporting classes.
- */
+/// @class ExportData
+/// @brief Base class for exporting classes.
 class EIBLE_EXPORT ExportData : public QObject
 {
     Q_OBJECT
 public:
     explicit ExportData(QObject* parent = nullptr);
 
-    /**
-     * @brief Export data from view to ioDevice.
-     * @param view Source of data.
-     * @param ioDevice Destination of exported content.
-     * @return True if success, false if failure.
-     */
+    /// @brief Export data from view to ioDevice.
+    /// @param view Source of data.
+    /// @param ioDevice Destination of exported content.
+    /// @return True if success, false if failure.
     bool exportView(const QAbstractItemView& view, QIODevice& ioDevice);
 
 protected:
@@ -47,9 +43,7 @@ class EIBLE_EXPORT ExportData : public QObject
     static bool rowShouldBeSkipped(const QAbstractItemView& view, int row);
 
 Q_SIGNALS:
-    /**
-     * Triggered on change of progress percentage.
-     * @param currentPercent New progress percent.
-     */
+    /// Triggered on change of progress percentage.
+    /// @param currentPercent New progress percent.
     void progressPercentChanged(int currentPercent);
 };

include/eible/ExportDsv.h

@@ -8,36 +8,26 @@
 class QAbstractItemView;
 class QIODevice;
 
-/**
- * @class ExportDsv
- * @brief Class for exporting data to DSV (Delimiter Separated Values) files.
- */
+/// @class ExportDsv
+/// @brief Class for exporting data to DSV (Delimiter Separated Values) files.
 class EIBLE_EXPORT ExportDsv : public ExportData
 {
     Q_OBJECT
 public:
-    /**
-     * @brief Constructor.
-     * @param separator Separator to be used during export (comma, tab, ...).
-     */
+    /// @brief Constructor.
+    /// @param separator Separator to be used during export (comma, tab, ...).
     explicit ExportDsv(char separator, QObject* parent = nullptr);
 
-    /**
-     * @brief Change date format to given one via Qt::DateFormat. (overloaded)
-     * @param format New format for dates as Qt::DateFormat.
-     */
+    /// @brief Change date format to given one via Qt::DateFormat. (overloaded)
+    /// @param format New format for dates as Qt::DateFormat.
     void setDateFormat(Qt::DateFormat format);
 
-    /**
-     * @brief Change date format to given one via string. (overloaded)
-     * @param format New format for dates as string.
-     */
+    /// @brief Change date format to given one via string. (overloaded)
+    /// @param format New format for dates as string.
     void setDateFormat(const QString& format);
 
-    /**
-     * @brief Set locale for numbers conversion.
-     * @param locale Locale to be used in exporting.
-     */
+    /// @brief Set locale for numbers conversion.
+    /// @param locale Locale to be used in exporting.
     void setNumbersLocale(const QLocale& locale);
 
 protected:

include/eible/ExportXlsx.h

@@ -9,10 +9,8 @@ class QAbstractItemModel;
 class QAbstractItemView;
 class QIODevice;
 
-/**
- * @class ExportXlsx
- * @brief Class for exporting data to xlsx files.
- */
+/// @class ExportXlsx
+/// @brief Class for exporting data to xlsx files.
 class EIBLE_EXPORT ExportXlsx : public ExportData
 {
     Q_OBJECT

include/eible/ImportOds.h

@@ -11,18 +11,14 @@ class QuaZipFile;
 class QXmlStreamReader;
 class QXmlStreamAttributes;
 
-/**
- * @class ImportOds
- * @brief Class analysing content and loading it from ods files.
- */
+/// @class ImportOds
+/// @brief Class analysing content and loading it from ods files.
 class EIBLE_EXPORT ImportOds : public ImportSpreadsheet
 {
     Q_OBJECT
 public:
-    /**
-     * @brief Constructor.
-     * @param ioDevice Source of data (QFile, QBuffer, ...).
-     */
+    /// @brief Constructor.
+    /// @param ioDevice Source of data (QFile, QBuffer, ...).
     explicit ImportOds(QIODevice& ioDevice);
 
     std::pair<bool, QStringList> getSheetNames() override;

include/eible/ImportSpreadsheet.h

@@ -10,84 +10,62 @@
 class QIODevice;
 class QuaZipFile;
 
-/**
- * @class ImportSpreadsheet
- * @brief Base class for spreadsheet importing classes.
- */
+/// @class ImportSpreadsheet
+/// @brief Base class for spreadsheet importing classes.
 class EIBLE_EXPORT ImportSpreadsheet : public QObject
 {
     Q_OBJECT
 public:
-    /**
-     * @brief Constructor.
-     * @param ioDevice Source of data (QFile, QBuffer, ...).
-     */
+    /// @brief Constructor.
+    /// @param ioDevice Source of data (QFile, QBuffer, ...).
     explicit ImportSpreadsheet(QIODevice& ioDevice);
 
-    /**
-     * @brief Get list of sheet names.
-     * @return First value indicating success, second is sheet names list.
-     */
+    /// @brief Get list of sheet names.
+    /// @return First value indicating success, second is sheet names list.
     virtual std::pair<bool, QStringList> getSheetNames() = 0;
 
-    /**
-     * @brief Get list of column names.
-     * @param sheetName Sheet name.
-     * @return First value indicating success, second is column names list.
-     */
+    /// @brief Get list of column names.
+    /// @param sheetName Sheet name.
+    /// @return First value indicating success, second is column names list.
     virtual std::pair<bool, QStringList> getColumnNames(
         const QString& sheetName) = 0;
 
-    /**
-     * @brief Get list of column types.
-     * @param sheetName Sheet name.
-     * @return First value indicating success, second is column types vector.
-     */
+    /// @brief Get list of column types.
+    /// @param sheetName Sheet name.
+    /// @return First value indicating success, second is column types vector.
     virtual std::pair<bool, QVector<ColumnType>> getColumnTypes(
         const QString& sheetName) = 0;
 
-    /**
-     * @brief Get last error.
-     * @return First value contains function name, second error.
-     */
+    /// @brief Get last error.
+    /// @return First value contains function name, second error.
     QString getLastError() const;
 
-    /**
-     * @brief Set name used for empty columns.
-     * @param name Name for empty column.
-     */
+    /// @brief Set name used for empty columns.
+    /// @param name Name for empty column.
     void setNameForEmptyColumn(const QString& name);
 
-    /**
-     * @brief Get number of columns in given sheet.
-     * @param sheetName Sheet name.
-     * @return First value indicating success, second is column count.
-     */
+    /// @brief Get number of columns in given sheet.
+    /// @param sheetName Sheet name.
+    /// @return First value indicating success, second is column count.
     std::pair<bool, int> getColumnCount(const QString& sheetName);
 
-    /**
-     * @brief Get number of rows in given sheet.
-     * @param sheetName Sheet name.
-     * @return First value indicating success, second is row count.
-     */
+    /// @brief Get number of rows in given sheet.
+    /// @param sheetName Sheet name.
+    /// @return First value indicating success, second is row count.
     std::pair<bool, int> getRowCount(const QString& sheetName);
 
-    /**
-     * @brief Get data from sheet.
-     * @param sheetName Sheet name.
-     * @param excludedColumns Vector of excluded columns (indexes).
-     * @return First value indicating success, second is vector of data rows.
-     */
+    /// @brief Get data from sheet.
+    /// @param sheetName Sheet name.
+    /// @param excludedColumns Vector of excluded columns (indexes).
+    /// @return First value indicating success, second is vector of data rows.
     std::pair<bool, QVector<QVector<QVariant>>> getData(
         const QString& sheetName, const QVector<int>& excludedColumns);
 
-    /**
-     * @brief Get limited data from sheet.
-     * @param sheetName Sheet name.
-     * @param excludedColumns Vector of excluded columns (indexes).
-     * @param rowLimit Number of rows to load.
-     * @return First value indicating success, second is vector of data rows.
-     */
+    /// @brief Get limited data from sheet.
+    /// @param sheetName Sheet name.
+    /// @param excludedColumns Vector of excluded columns (indexes).
+    /// @param rowLimit Number of rows to load.
+    /// @return First value indicating success, second is vector of data rows.
     virtual std::pair<bool, QVector<QVector<QVariant>>> getLimitedData(
         const QString& sheetName, const QVector<int>& excludedColumns,
         int rowLimit) = 0;
@@ -148,9 +126,7 @@ class EIBLE_EXPORT ImportSpreadsheet : public QObject
     QuaZip zip_;
 
 Q_SIGNALS:
-    /**
-     * Triggered on change of progress percentage.
-     * @param progressPercent New progress percent.
-     */
+    /// Triggered on change of progress percentage.
+    /// @param progressPercent New progress percent.
     void progressPercentChanged(int progressPercent);
 };

include/eible/ImportXlsx.h

@@ -12,18 +12,14 @@ class QuaZip;
 class QuaZipFile;
 class QXmlStreamReader;
 
-/**
- * @class ImportXlsx
- * @brief Class analysing content and loading it from xlsx files.
- */
+/// @class ImportXlsx
+/// @brief Class analysing content and loading it from xlsx files.
 class EIBLE_EXPORT ImportXlsx : public ImportSpreadsheet
 {
     Q_OBJECT
 public:
-    /**
-     * @brief Constructor.
-     * @param ioDevice Source of data (QFile, QBuffer, ...).
-     */
+    /// @brief Constructor.
+    /// @param ioDevice Source of data (QFile, QBuffer, ...).
     explicit ImportXlsx(QIODevice& ioDevice);
 
     std::pair<bool, QStringList> getSheetNames() override;
@@ -34,22 +30,16 @@ class EIBLE_EXPORT ImportXlsx : public ImportSpreadsheet
     std::pair<bool, QStringList> getColumnNames(
         const QString& sheetName) override;
 
-    /**
-     * @brief Get shared strings from xlsx.
-     * @return First value indicating success, second list of shared strings.
-     */
+    /// @brief Get shared strings from xlsx.
+    /// @return First value indicating success, second list of shared strings.
     std::pair<bool, QStringList> getSharedStrings();
 
-    /**
-     * @brief Get date styles from xlsx.
-     * @return First value indicating success, second list of date style ids.
-     */
+    /// @brief Get date styles from xlsx.
+    /// @return First value indicating success, second list of date style ids.
     std::pair<bool, QList<int>> getDateStyles();
 
-    /**
-     * @brief Get all styles from xlsx.
-     * @return First value indicating success, second list of all style ids.
-     */
+    /// @brief Get all styles from xlsx.
+    /// @return First value indicating success, second list of all style ids.
     std::pair<bool, QList<int>> getAllStyles();
 
     std::pair<bool, QVector<QVector<QVariant>>> getLimitedData(