diff --git a/cdatetimepicker.cpp b/cdatetimepicker.cpp index 472a7ab..d7aef40 100644 --- a/cdatetimepicker.cpp +++ b/cdatetimepicker.cpp @@ -1,3 +1,8 @@ +/*! + \file cdatetimepicker.cpp + +*/ + #include "cdatetimepicker.h" #include "ui_cdatetimepicker.h" diff --git a/cdatetimepicker.h b/cdatetimepicker.h index 627e63b..9c30a8d 100644 --- a/cdatetimepicker.h +++ b/cdatetimepicker.h @@ -1,3 +1,8 @@ +/*! + \file cdatetimepicker.h + +*/ + #ifndef CDATETIMEPICKER_H #define CDATETIMEPICKER_H @@ -10,53 +15,60 @@ namespace Ui { class cDateTimePicker; } -/** - * @brief - * - */ +/*! + \brief + + \class cDateTimePicker cdatetimepicker.h "cdatetimepicker.h" +*/ class cDateTimePicker : public QDialog { Q_OBJECT public: - /** - * @brief - * - * @param parent - */ + /*! + \brief + + \fn cDateTimePicker + \param parent + */ explicit cDateTimePicker(QWidget *parent = nullptr); - /** - * @brief - * - */ + /*! + \brief + + \fn ~cDateTimePicker + */ ~cDateTimePicker(); - /** - * @brief - * - * @param szText - */ + /*! + \brief + + \fn setText + \param szText + */ void setText(const QString& szText); - /** - * @brief - * - * @param image - */ + /*! + \brief + + \fn setImage + \param image + */ void setImage(const QImage& image); - /** - * @brief - * - * @param dateTime - */ + /*! + \brief + + \fn setDateTime + \param dateTime + */ void setDateTime(const QDateTime dateTime); - /** - * @brief - * - * @return QDateTime - */ + /*! + \brief + + \fn dateTime + \return QDateTime + */ QDateTime dateTime(); private: - Ui::cDateTimePicker* ui; /**< TODO: describe */ + Ui::cDateTimePicker* ui; /*!< TODO: describe */ }; #endif // CDATETIMEPICKER_H diff --git a/cexif.cpp b/cexif.cpp index 8bbb693..41df91b 100644 --- a/cexif.cpp +++ b/cexif.cpp @@ -1,3 +1,8 @@ +/*! + \file cexif.cpp + +*/ + #include "cexif.h" #include "common.h" diff --git a/cexif.h b/cexif.h index 0b725b5..d323c62 100644 --- a/cexif.h +++ b/cexif.h @@ -1,3 +1,8 @@ +/*! + \file cexif.h + +*/ + #ifndef CEXIF_H #define CEXIF_H @@ -12,152 +17,167 @@ #include -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFCompression cexif.h "cexif.h" +*/ class cEXIFCompression { public: cEXIFCompression(const qint32& iID, const QString& szCompression); - qint32 m_iID; /**< TODO: describe */ - QString m_szCompression; /**< TODO: describe */ + qint32 m_iID; /*!< TODO: describe */ + QString m_szCompression; /*!< TODO: describe */ }; Q_DECLARE_METATYPE(cEXIFCompression*) -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFCompressionList cexif.h "cexif.h" +*/ class cEXIFCompressionList : public QList { public: cEXIFCompressionList(); - /** - * @brief - * - * @param iID - * @param szCompression - * @return cEXIFCompression - */ + /*! + \brief + + \fn add + \param iID + \param szCompression + \return cEXIFCompression + */ cEXIFCompression* add(const qint32& iID, const QString& szCompression); - /** - * @brief - * - * @param iID - * @return cEXIFCompression - */ + /*! + \brief + + \fn find + \param iID + \return cEXIFCompression + */ cEXIFCompression* find(const qint32& iID); - /** - * @brief - * - * @param iID - * @return QString - */ + /*! + \brief + + \fn compression + \param iID + \return QString + */ QString compression(const qint32& iID); }; Q_DECLARE_METATYPE(cEXIFCompressionList) -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFLightSource cexif.h "cexif.h" +*/ class cEXIFLightSource { public: cEXIFLightSource(const qint32& iID, const QString& szLightSource); - qint32 m_iID; /**< TODO: describe */ - QString m_szLightSource; /**< TODO: describe */ + qint32 m_iID; /*!< TODO: describe */ + QString m_szLightSource; /*!< TODO: describe */ }; Q_DECLARE_METATYPE(cEXIFLightSource*) -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFLightSourceList cexif.h "cexif.h" +*/ class cEXIFLightSourceList : public QList { public: cEXIFLightSourceList(); - /** - * @brief - * - * @param iID - * @param szLightSource - * @return cEXIFLightSource - */ + /*! + \brief + + \fn add + \param iID + \param szLightSource + \return cEXIFLightSource + */ cEXIFLightSource* add(const qint32& iID, const QString& szLightSource); - /** - * @brief - * - * @param iID - * @return cEXIFLightSource - */ + /*! + \brief + + \fn find + \param iID + \return cEXIFLightSource + */ cEXIFLightSource* find(const qint32& iID); - /** - * @brief - * - * @param iID - * @return QString - */ + /*! + \brief + + \fn lightSource + \param iID + \return QString + */ QString lightSource(const qint32& iID); }; -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFFlash cexif.h "cexif.h" +*/ class cEXIFFlash { public: cEXIFFlash(const qint32& iID, const QString& szFlash); - qint32 m_iID; /**< TODO: describe */ - QString m_szFlash; /**< TODO: describe */ + qint32 m_iID; /*!< TODO: describe */ + QString m_szFlash; /*!< TODO: describe */ }; Q_DECLARE_METATYPE(cEXIFFlash*) -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFFlashList cexif.h "cexif.h" +*/ class cEXIFFlashList : public QList { public: cEXIFFlashList(); - /** - * @brief - * - * @param iID - * @param szFlash - * @return cEXIFFlash - */ + /*! + \brief + + \fn add + \param iID + \param szFlash + \return cEXIFFlash + */ cEXIFFlash* add(const qint32& iID, const QString& szFlash); - /** - * @brief - * - * @param iID - * @return cEXIFFlash - */ + /*! + \brief + + \fn find + \param iID + \return cEXIFFlash + */ cEXIFFlash* find(const qint32& iID); - /** - * @brief - * - * @param iID - * @return QString - */ + /*! + \brief + + \fn flash + \param iID + \return QString + */ QString flash(const qint32& iID); }; @@ -170,321 +190,351 @@ class cEXIFTag public: cEXIFTag(const qint32& iTAGID, const QString& szTAGName, const qint32& iIFDID, const qint32& iTypeID, const QString& szDescription); - qint32 m_iTAGID; /**< TODO: describe */ - QString m_szTAGName; /**< TODO: describe */ - qint32 m_iIFDID; /**< TODO: describe */ - qint32 m_iTypeID; /**< TODO: describe */ - QString m_szDescription; /**< TODO: describe */ + qint32 m_iTAGID; /*!< TODO: describe */ + QString m_szTAGName; /*!< TODO: describe */ + qint32 m_iIFDID; /*!< TODO: describe */ + qint32 m_iTypeID; /*!< TODO: describe */ + QString m_szDescription; /*!< TODO: describe */ }; Q_DECLARE_METATYPE(cEXIFTag*) -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFTagList cexif.h "cexif.h" +*/ class cEXIFTagList : public QList { public: - /** - * @brief - * - */ cEXIFTagList(); - /** - * @brief - * - * @param iTAGID - * @param szTAGName - * @param iIFDID - * @param iTypeID - * @param szDescription - * @return cEXIFTag - */ + /*! + \brief + + \fn add + \param iTAGID + \param szTAGName + \param iIFDID + \param iTypeID + \param szDescription + \return cEXIFTag + */ cEXIFTag* add(const qint32& iTAGID, const QString& szTAGName, const qint32& iIFDID, const qint32& iTypeID, const QString& szDescription); - /** - * @brief - * - * @param iTAGID - * @param iIFDID - * @return cEXIFTag - */ + /*! + \brief + + \fn find + \param iTAGID + \param iIFDID + \return cEXIFTag + */ cEXIFTag* find(const qint32& iTAGID, const qint32& iIFDID); }; -/** - * @brief - * - */ +/*! + \brief + +*/ class cEXIFValue { public: - /** - * @brief - * - * @param lpEXIFTag - */ cEXIFValue(cEXIFTag* lpEXIFTag); - /** - * @brief - * - * @return cEXIFTag - */ + /*! + \brief + + \fn exifTag + \return cEXIFTag + */ cEXIFTag* exifTag(); - /** - * @brief - * - * @param szValue - * @param iTypeId - * @param iCount - */ + /*! + \brief + + \fn setValue + \param szValue + \param iTypeId + \param iCount + */ void setValue(const QString& szValue, qint32 iTypeId, qint32 iCount = 1); - /** - * @brief - * - * @return QVariant - */ + /*! + \brief + + \fn value + \return QVariant + */ QVariant value(); - /** - * @brief - * - * @return QList - */ + /*! + \brief + + \fn valueList + \return QList + */ QList valueList(); private: - cEXIFTag* m_lpEXIFTag; /**< TODO: describe */ - QList m_valueList; /**< TODO: describe */ + cEXIFTag* m_lpEXIFTag; /*!< TODO: describe */ + QList m_valueList; /*!< TODO: describe */ - /** - * @brief - * - * @param szValue - * @param iTypeId - * @return QVariant - */ + /*! + \brief + + \fn convertValue + \param szValue + \param iTypeId + \return QVariant + */ QVariant convertValue(const QString& szValue, qint32 iTypeId); }; Q_DECLARE_METATYPE(cEXIFValue*) -/** - * @brief - * - */ +/*! + \brief + + \class cEXIFValueList cexif.h "cexif.h" +*/ class cEXIFValueList : public QList { public: cEXIFValueList(); - /** - * @brief - * - * @param lpEXIFTag - * @return cEXIFValue - */ + /*! + \brief + + \fn add + \param lpEXIFTag + \return cEXIFValue + */ cEXIFValue* add(cEXIFTag* lpEXIFTag); - /** - * @brief - * - * @param lpEXIFTag - * @return cEXIFValue - */ + /*! + \brief + + \fn find + \param lpEXIFTag + \return cEXIFValue + */ cEXIFValue* find(cEXIFTag* lpEXIFTag); }; -/** - * @brief - * - */ +/*! + \brief + + \class cEXIF cexif.h "cexif.h" +*/ class cEXIF { public: cEXIF(); - /** - * @brief - * - * @param szFileName - * @return bool - */ + /*! + \brief + + \fn fromFile + \param szFileName + \return bool + */ bool fromFile(const QString& szFileName); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn imageWidth + \return qint32 + */ qint32 imageWidth(); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn imageHeight + \return qint32 + */ qint32 imageHeight(); - /** - * @brief - * - * @return qint16 - */ + /*! + \brief + + \fn imageOrientation + \return qint16 + */ qint16 imageOrientation(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn cameraMake + \return QString + */ QString cameraMake(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn cameraModel + \return QString + */ QString cameraModel(); - /** - * @brief - * - * @return QDateTime - */ + /*! + \brief + + \fn dateTime + \return QDateTime + */ QDateTime dateTime(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn fNumber + \return QString + */ QString fNumber(); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn iso + \return qint32 + */ qint32 iso(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn flash + \return QString + */ QString flash(); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn flashID + \return qint32 + */ qint32 flashID(); - /** - * @brief - * - * @return qreal - */ + /*! + \brief + + \fn focalLength + \return qreal + */ qreal focalLength(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn lensMake + \return QString + */ QString lensMake(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn lensModel + \return QString + */ QString lensModel(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn exposureTime + \return QString + */ QString exposureTime(); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn exposureBias + \return qint32 + */ qint32 exposureBias(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn exifVersion + \return QString + */ QString exifVersion(); - /** - * @brief - * - * @return QDateTime - */ + /*! + \brief + + \fn dateTimeOriginal + \return QDateTime + */ QDateTime dateTimeOriginal(); - /** - * @brief - * - * @return QDateTime - */ + /*! + \brief + + \fn dateTimeDigitized + \return QDateTime + */ QDateTime dateTimeDigitized(); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn whiteBalance + \return qint32 + */ qint32 whiteBalance(); - /** - * @brief - * - * @return qreal - */ + /*! + \brief + + \fn focalLength35 + \return qreal + */ qreal focalLength35(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn gps + \return QString + */ QString gps(); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn fileName + \return QString + */ QString fileName(); - /** - * @brief - * - * @return QList - */ + /*! + \brief + + \fn previewList + \return QList + */ QList previewList(); - /** - * @brief - * - * @return QImage - */ + /*! + \brief + + \fn thumbnail + \return QImage + */ QImage thumbnail(); private: - cEXIFValueList m_exifValueList; /**< TODO: describe */ - qint32 m_iWidth; /**< TODO: describe */ - qint32 m_iHeight; /**< TODO: describe */ - QString m_szFileName; /**< TODO: describe */ - QList m_previewList; /**< TODO: describe */ - QImage m_thumbnail; /**< TODO: describe */ + cEXIFValueList m_exifValueList; /*!< TODO: describe */ + qint32 m_iWidth; /*!< TODO: describe */ + qint32 m_iHeight; /*!< TODO: describe */ + QString m_szFileName; /*!< TODO: describe */ + QList m_previewList; /*!< TODO: describe */ + QImage m_thumbnail; /*!< TODO: describe */ - cEXIFCompressionList m_exifCompressionList; /**< TODO: describe */ - cEXIFLightSourceList m_exifLightSourceList; /**< TODO: describe */ - cEXIFFlashList m_exifFlashList; /**< TODO: describe */ - cEXIFTagList m_exifTagList; /**< TODO: describe */ + cEXIFCompressionList m_exifCompressionList; /*!< TODO: describe */ + cEXIFLightSourceList m_exifLightSourceList; /*!< TODO: describe */ + cEXIFFlashList m_exifFlashList; /*!< TODO: describe */ + cEXIFTagList m_exifTagList; /*!< TODO: describe */ - /** - * @brief - * - * @param iTAGID - * @param iIFDID - * @return QVariant - */ + /*! + \brief + + \fn getTag + \param iTAGID + \param iIFDID + \return QVariant + */ QVariant getTag(qint32 iTAGID, qint32 iIFDID); - /** - * @brief - * - * @param iTAGID - * @param iIFDID - * @return QList - */ + /*! + \brief + + \fn getTagList + \param iTAGID + \param iIFDID + \return QList + */ QList getTagList(qint32 iTAGID, qint32 iIFDID); }; diff --git a/cimage.cpp b/cimage.cpp index 15407ba..26d0066 100644 --- a/cimage.cpp +++ b/cimage.cpp @@ -1,3 +1,8 @@ +/*! + \file cimage.cpp + +*/ + #include "cimage.h" #include "libraw/libraw.h" diff --git a/cimage.h b/cimage.h index 6145f5e..695cc7b 100644 --- a/cimage.h +++ b/cimage.h @@ -1,3 +1,8 @@ +/*! + \file cimage.h + +*/ + #ifndef CIMAGE_H #define CIMAGE_H @@ -5,111 +10,123 @@ #include -/** - * @brief - * - */ +/*! + \brief + + \class cImage cimage.h "cimage.h" +*/ class cImage : public QImage { public: cImage(); - /** - * @brief - * - * @param size - * @param format - */ + /*! + \brief + + \fn cImage + \param size + \param format + */ cImage(const QSize &size, QImage::Format format); - /** - * @brief - * - * @param width - * @param height - * @param format - */ + /*! + \brief + + \fn cImage + \param width + \param height + \param format + */ cImage(int width, int height, QImage::Format format); - /** - * @brief - * - * @param data - * @param width - * @param height - * @param format - * @param cleanupFunction - * @param cleanupInfo - */ + /*! + \brief + + \fn cImage + \param data + \param width + \param height + \param format + \param cleanupFunction + \param cleanupInfo + */ cImage(uchar *data, int width, int height, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr); - /** - * @brief - * - * @param data - * @param width - * @param height - * @param format - * @param cleanupFunction - * @param cleanupInfo - */ + /*! + \brief + + \fn cImage + \param data + \param width + \param height + \param format + \param cleanupFunction + \param cleanupInfo + */ cImage(const uchar *data, int width, int height, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr); - /** - * @brief - * - * @param data - * @param width - * @param height - * @param bytesPerLine - * @param format - * @param cleanupFunction - * @param cleanupInfo - */ + /*! + \brief + + \fn cImage + \param data + \param width + \param height + \param bytesPerLine + \param format + \param cleanupFunction + \param cleanupInfo + */ cImage(uchar *data, int width, int height, int bytesPerLine, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr); - /** - * @brief - * - * @param data - * @param width - * @param height - * @param bytesPerLine - * @param format - * @param cleanupFunction - * @param cleanupInfo - */ + /*! + \brief + + \fn cImage + \param data + \param width + \param height + \param bytesPerLine + \param format + \param cleanupFunction + \param cleanupInfo + */ cImage(const uchar *data, int width, int height, int bytesPerLine, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr); - /** - * @brief - * - * @param fileName - * @param format - */ + /*! + \brief + + \fn cImage + \param fileName + \param format + */ cImage(const QString &fileName, const char *format = nullptr); - /** - * @brief - * - * @param image - */ + /*! + \brief + + \fn cImage + \param image + */ cImage(const QImage &image); - /** - * @brief - * - * @param other - */ + /*! + \brief + + \fn cImage + \param other + */ cImage(QImage &&other); - /** - * @brief - * - * @param fileName - * @param format - * @return bool - */ + /*! + \brief + + \fn load + \param fileName + \param format + \return bool + */ bool load(const QString &fileName, const char *format = nullptr); private: - /** - * @brief - * - * @param fileName - * @return bool - */ + /*! + \brief + + \fn loadRAW + \param fileName + \return bool + */ bool loadRAW(const QString &fileName); }; diff --git a/cimportdialog.cpp b/cimportdialog.cpp index 6243430..2a829c3 100644 --- a/cimportdialog.cpp +++ b/cimportdialog.cpp @@ -1,3 +1,8 @@ +/*! + \file cimportdialog.cpp + +*/ + #include "cimportdialog.h" #include "ui_cimportdialog.h" diff --git a/cimportdialog.h b/cimportdialog.h index f0ccdf2..5694028 100644 --- a/cimportdialog.h +++ b/cimportdialog.h @@ -1,3 +1,8 @@ +/*! + \file cimportdialog.h + +*/ + #ifndef CIMPORTDIALOG_H #define CIMPORTDIALOG_H @@ -14,32 +19,37 @@ namespace Ui { class cImportDialog; } -/** - * @brief - * - */ +/*! + \brief + + \class cImportDialog cimportdialog.h "cimportdialog.h" +*/ class cImportDialog : public QDialog { Q_OBJECT public: - /** - * @brief - * - * @param parent - */ + /*! + \brief + + \fn cImportDialog + \param szRootPath + \param parent + */ explicit cImportDialog(const QString& szRootPath, QWidget *parent = nullptr); - /** - * @brief - * - */ + /*! + \brief + + \fn ~cImportDialog + */ ~cImportDialog(); - /** - * @brief - * - * @return bool - */ + /*! + \brief + + \fn hasImported + \return bool + */ bool hasImported(); private slots: @@ -63,28 +73,30 @@ private slots: void onImport(); /*! \brief + + \fn onThumbnailSelected \param selection \param previous - \fn onThumbnailSelected */ void onThumbnailSelected(const QItemSelection& selection, const QItemSelection& previous); /*! \brief + + \fn onFolderSelected \param selection \param previous - \fn onThumbnailSelected */ void onFolderSelected(const QItemSelection& selection, const QItemSelection& previous); private: - Ui::cImportDialog* ui; /**< TODO: describe */ - QString m_szRootPath; /**< TODO: describe */ - QStandardItemModel* m_lpFolderViewModel; /**< TODO: describe */ - QStandardItemModel* m_lpThumbnailViewModel; /**< TODO: describe */ - cThumbnailFilterProxyModel* m_lpThumbnailFilterProxyModel; /**< TODO: describe */ - bool m_bLoading; /**< TODO: describe */ - bool m_bHasImported; /**< TODO: describe */ - QStandardItem* m_lpRootItem; /**< TODO: describe */ + Ui::cImportDialog* ui; /*!< TODO: describe */ + QString m_szRootPath; /*!< TODO: describe */ + QStandardItemModel* m_lpFolderViewModel; /*!< TODO: describe */ + QStandardItemModel* m_lpThumbnailViewModel; /*!< TODO: describe */ + cThumbnailFilterProxyModel* m_lpThumbnailFilterProxyModel; /*!< TODO: describe */ + bool m_bLoading; /*!< TODO: describe */ + bool m_bHasImported; /*!< TODO: describe */ + QStandardItem* m_lpRootItem; /*!< TODO: describe */ /*! \brief @@ -99,29 +111,33 @@ private: */ void createActions(); - /** - * @brief - * - * @param szPath - * @param bRecursive - */ + /*! + \brief + + \fn readDirectory + \param szPath + \param bRecursive + */ void readDirectory(const QString& szPath, bool bRecursive); - /** - * @brief - * - */ + /*! + \brief + + \fn accept + */ void accept(); - /** - * @brief - * - */ + /*! + \brief + + \fn reject + */ void reject(); - /** - * @brief - * - */ + /*! + \brief + + \fn savePosition + */ void savePosition(); protected: }; diff --git a/cmainwindow.cpp b/cmainwindow.cpp index 1b46357..6e09193 100644 --- a/cmainwindow.cpp +++ b/cmainwindow.cpp @@ -1,3 +1,8 @@ +/*! + \file cmainwindow.cpp + +*/ + #include "common.h" #include "cmainwindow.h" diff --git a/cmainwindow.h b/cmainwindow.h index a335687..5479180 100644 --- a/cmainwindow.h +++ b/cmainwindow.h @@ -1,3 +1,8 @@ +/*! + \file cmainwindow.h + +*/ + #ifndef CMAINWINDOW_H #define CMAINWINDOW_H @@ -28,45 +33,48 @@ class cMainWindow; Q_DECLARE_METATYPE(QList*) -/** - * @brief - * - */ +/*! + \brief + + \class cMainWindow cmainwindow.h "cmainwindow.h" +*/ class cMainWindow : public QMainWindow { Q_OBJECT public: - /** - * @brief - * - * @param lpSplashScreen - * @param parent - */ + /*! + \brief + + \fn cMainWindow + \param lpSplashScreen + \param parent + */ explicit cMainWindow(cSplashScreen* lpSplashScreen, QWidget *parent = nullptr); - /** - * @brief - * - */ + /*! + \brief + + \fn ~cMainWindow + */ ~cMainWindow(); private: - Ui::cMainWindow* ui; /**< TODO: describe */ - QProgressBar* m_lpProgressBar; /**< TODO: describe */ - QStandardItemModel* m_lpFolderViewModel; /**< TODO: describe */ - QStandardItemModel* m_lpThumbnailViewModel; /**< TODO: describe */ - cThumbnailFilterProxyModel* m_lpThumbnailFilterProxyModel; /**< TODO: describe */ - QStandardItem* m_lpRootItem; /**< TODO: describe */ + Ui::cMainWindow* ui; /*!< TODO: describe */ + QProgressBar* m_lpProgressBar; /*!< TODO: describe */ + QStandardItemModel* m_lpFolderViewModel; /*!< TODO: describe */ + QStandardItemModel* m_lpThumbnailViewModel; /*!< TODO: describe */ + cThumbnailFilterProxyModel* m_lpThumbnailFilterProxyModel; /*!< TODO: describe */ + QStandardItem* m_lpRootItem; /*!< TODO: describe */ - bool m_bLoading; /**< TODO: describe */ + bool m_bLoading; /*!< TODO: describe */ - cSplashScreen* m_lpSplashScreen; /*!< Splash Screen */ - cPictureLibrary m_pictureLibrary; /**< TODO: describe */ - cPictureList m_pictureList; /**< TODO: describe */ + cSplashScreen* m_lpSplashScreen; /*!< TODO: describe */ + cPictureLibrary m_pictureLibrary; /*!< TODO: describe */ + cPictureList m_pictureList; /*!< TODO: describe */ - QMenu* m_lpFileMenu; /*!< Pointer to the file menu */ + QMenu* m_lpFileMenu; /*!< TODO: describe */ - QToolBar* m_lpFileToolBar; /*!< Pointer to the file toolbar */ + QToolBar* m_lpFileToolBar; /*!< TODO: describe */ QAction* m_lpFileNewAction; /*!< TODO: describe */ QAction* m_lpFileOpenAction; /*!< TODO: describe */ @@ -74,10 +82,10 @@ private: QAction* m_lpFileQuitAction; /*!< TODO: describe */ QAction* m_lpSeparatorRecent; /*!< TODO: describe */ - enum { MaxRecentFiles = 5 }; /*!< TODO: describe */ + enum { MaxRecentFiles = 5 }; /*!< TODO: describe */ QAction* m_lpRecentFileAction[MaxRecentFiles]; /*!< TODO: describe */ - QAction* m_lpChangeDateAction; /*!< TODO: describe */ + QAction* m_lpChangeDateAction; /*!< TODO: describe */ /*! \brief @@ -85,23 +93,8 @@ private: \fn initUI */ void initUI(); - /*! - \brief - - \fn createActions - */ - void createActions(); - /*! - \brief - - \fn createFileActions - */ + void createActions(); /*!< TODO: describe */ void createFileActions(); - /*! - \brief - - \fn createContextActions - */ void createContextActions(); /*! @@ -128,6 +121,7 @@ private: \brief \fn loadData + \param bProgressBar */ void loadData(bool bProgressBar = false); @@ -143,16 +137,18 @@ protected: private slots: /*! \brief + + \fn onThumbnailSelected \param selection \param previous - \fn onThumbnailSelected */ void onThumbnailSelected(const QItemSelection& selection, const QItemSelection& previous); /*! \brief + + \fn onFolderSelected \param selection \param previous - \fn onThumbnailSelected */ void onFolderSelected(const QItemSelection& selection, const QItemSelection& previous); /*! diff --git a/common.cpp b/common.cpp index 2df8eca..7897de9 100644 --- a/common.cpp +++ b/common.cpp @@ -3,6 +3,11 @@ */ +/*! + \file common.cpp + +*/ + #include "common.h" #include diff --git a/common.h b/common.h index e9d8e23..29bbba1 100644 --- a/common.h +++ b/common.h @@ -26,21 +26,30 @@ #define myDebug qDebug() << __FILE__ << "(" << __LINE__ << ") - " << __FUNCTION__ << ":" #endif -/** - * @brief - * - * @param ba - * @return QImage - */ +/*! + \brief + + \fn blob2Image + \param ba + \return QImage +*/ QImage blob2Image(const QByteArray& ba); -/** - * @brief - * - * @param image - * @return QByteArray - */ +/*! + \brief + + \fn image2Blob + \param image + \return QByteArray +*/ QByteArray image2Blob(const QImage& image); +/*! + \brief + + \fn insertPath + \param szPath + \param lpRootItem +*/ void insertPath(QString szPath, QStandardItem* lpRootItem); diff --git a/cpicture.cpp b/cpicture.cpp index b8d3ff0..59954ad 100644 --- a/cpicture.cpp +++ b/cpicture.cpp @@ -1,3 +1,8 @@ +/*! + \file cpicture.cpp + +*/ + #include "common.h" #include "cexif.h" diff --git a/cpicture.h b/cpicture.h index 750c7c4..05f189a 100644 --- a/cpicture.h +++ b/cpicture.h @@ -1,3 +1,8 @@ +/*! + \file cpicture.h + +*/ + #ifndef CPICTURE_H #define CPICTURE_H @@ -14,371 +19,428 @@ #include -/** - * @brief - * - */ +/*! + \brief + + \class cPicture cpicture.h "cpicture.h" +*/ class cPicture : public QObject { Q_OBJECT public: - /** - * @brief - * - * @param parent - */ + /*! + \brief + + \fn cPicture + \param iID + \param parent + */ explicit cPicture(qint32 iID = -1, QObject *parent = nullptr); - /** - * @brief - * - * @param szFileName - * @return bool - */ + /*! + \brief + + \fn fromFile + \param szFileName + \return bool + */ bool fromFile(const QString& szFileName); - /** - * @brief - * - * @return bool - */ + /*! + \brief + + \fn toDB + \return bool + */ bool toDB(); - /** - * @brief - * - * @param id - */ + /*! + \brief + + \fn setID + \param id + */ void setID(const qint32& id); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn id + \return qint32 + */ qint32 id(); - /** - * @brief - * - * @param imageWidth - */ + /*! + \brief + + \fn setImageWidth + \param imageWidth + */ void setImageWidth(const qint32& imageWidth); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn imageWidth + \return qint32 + */ qint32 imageWidth(); - /** - * @brief - * - * @param imageHeight - */ + /*! + \brief + + \fn setImageHeight + \param imageHeight + */ void setImageHeight(const qint32& imageHeight); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn imageHeight + \return qint32 + */ qint32 imageHeight(); - /** - * @brief - * - * @param imageOrientation - */ + /*! + \brief + + \fn setImageOrientation + \param imageOrientation + */ void setImageOrientation(const qint16& imageOrientation); - /** - * @brief - * - * @return qint16 - */ + /*! + \brief + + \fn imageOrientation + \return qint16 + */ qint16 imageOrientation(); - /** - * @brief - * - * @param cameraMake - */ + /*! + \brief + + \fn setCameraMake + \param cameraMake + */ void setCameraMake(const QString& cameraMake); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn cameraMake + \return QString + */ QString cameraMake(); - /** - * @brief - * - * @param cameraModel - */ + /*! + \brief + + \fn setCameraModel + \param cameraModel + */ void setCameraModel(const QString& cameraModel); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn cameraModel + \return QString + */ QString cameraModel(); - /** - * @brief - * - * @param dateTime - */ + /*! + \brief + + \fn setDateTime + \param dateTime + */ void setDateTime(const QDateTime& dateTime); - /** - * @brief - * - * @return QDateTime - */ + /*! + \brief + + \fn dateTime + \return QDateTime + */ QDateTime dateTime(); - /** - * @brief - * - * @param fNumber - */ + /*! + \brief + + \fn setFNumber + \param fNumber + */ void setFNumber(const QString& fNumber); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn fNumber + \return QString + */ QString fNumber(); - /** - * @brief - * - * @param iso - */ + /*! + \brief + + \fn setISO + \param iso + */ void setISO(const qint32& iso); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn iso + \return qint32 + */ qint32 iso(); - /** - * @brief - * - * @param flash - */ + /*! + \brief + + \fn setFlash + \param flash + */ void setFlash(const QString& flash); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn flash + \return QString + */ QString flash(); - /** - * @brief - * - * @param flashID - */ + /*! + \brief + + \fn setFlashID + \param flashID + */ void setFlashID(const qint32& flashID); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn flashID + \return qint32 + */ qint32 flashID(); - /** - * @brief - * - * @param focalLength - */ + /*! + \brief + + \fn setFocalLength + \param focalLength + */ void setFocalLength(const qreal& focalLength); - /** - * @brief - * - * @return qreal - */ + /*! + \brief + + \fn focalLength + \return qreal + */ qreal focalLength(); - /** - * @brief - * - * @param lensMake - */ + /*! + \brief + + \fn setLensMake + \param lensMake + */ void setLensMake(const QString& lensMake); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn lensMake + \return QString + */ QString lensMake(); - /** - * @brief - * - * @param lensModel - */ + /*! + \brief + + \fn setLensModel + \param lensModel + */ void setLensModel(const QString& lensModel); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn lensModel + \return QString + */ QString lensModel(); - /** - * @brief - * - * @param exposureTime - */ + /*! + \brief + + \fn setExposureTime + \param exposureTime + */ void setExposureTime(const QString& exposureTime); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn exposureTime + \return QString + */ QString exposureTime(); - /** - * @brief - * - * @param exposureBias - */ + /*! + \brief + + \fn setExposureBias + \param exposureBias + */ void setExposureBias(const qint32& exposureBias); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn exposureBias + \return qint32 + */ qint32 exposureBias(); - /** - * @brief - * - * @param exifVersion - */ + /*! + \brief + + \fn setExifVersion + \param exifVersion + */ void setExifVersion(const QString& exifVersion); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn exifVersion + \return QString + */ QString exifVersion(); - /** - * @brief - * - * @param dateTimeOriginal - */ + /*! + \brief + + \fn setDateTimeOriginal + \param dateTimeOriginal + */ void setDateTimeOriginal(const QDateTime& dateTimeOriginal); - /** - * @brief - * - * @return QDateTime - */ + /*! + \brief + + \fn dateTimeOriginal + \return QDateTime + */ QDateTime dateTimeOriginal(); - /** - * @brief - * - * @param dateTimeDigitized - */ + /*! + \brief + + \fn setDateTimeDigitized + \param dateTimeDigitized + */ void setDateTimeDigitized(const QDateTime& dateTimeDigitized); - /** - * @brief - * - * @return QDateTime - */ + /*! + \brief + + \fn dateTimeDigitized + \return QDateTime + */ QDateTime dateTimeDigitized(); - /** - * @brief - * - * @param whiteBalance - */ + /*! + \brief + + \fn setWhiteBalance + \param whiteBalance + */ void setWhiteBalance(const qint32& whiteBalance); - /** - * @brief - * - * @return qint32 - */ + /*! + \brief + + \fn whiteBalance + \return qint32 + */ qint32 whiteBalance(); - /** - * @brief - * - * @param focalLength35 - */ + /*! + \brief + + \fn setFocalLength35 + \param focalLength35 + */ void setFocalLength35(const qreal& focalLength35); - /** - * @brief - * - * @return qreal - */ + /*! + \brief + + \fn focalLength35 + \return qreal + */ qreal focalLength35(); - /** - * @brief - * - * @param gps - */ + /*! + \brief + + \fn setGPS + \param gps + */ void setGPS(const QString& gps); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn gps + \return QString + */ QString gps(); - /** - * @brief - * - * @param fileName - */ + /*! + \brief + + \fn setFileName + \param fileName + */ void setFileName(const QString& fileName); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn fileName + \return QString + */ QString fileName(); - /** - * @brief - * - * @param filePath - */ + /*! + \brief + + \fn setFilePath + \param filePath + */ void setFilePath(const QString& filePath); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn filePath + \return QString + */ QString filePath(); - /** - * @brief - * - * @param fileSize - */ + /*! + \brief + + \fn setFileSize + \param fileSize + */ void setFileSize(const qint64& fileSize); - /** - * @brief - * - * @return qint64 - */ + /*! + \brief + + \fn fileSize + \return qint64 + */ qint64 fileSize(); - /** - * @brief - * - * @param thumbnail - */ + /*! + \brief + + \fn setThumbnail + \param thumbnail + */ void setThumbnail(const QImage& thumbnail); - /** - * @brief - * - * @return QImage - */ + /*! + \brief + + \fn thumbnail + \return QImage + */ QImage thumbnail(); signals: @@ -386,73 +448,79 @@ signals: public slots: private: - qint32 m_iID; /**< TODO: describe */ - QString m_szFileName; /**< TODO: describe */ - QString m_szFilePath; /**< TODO: describe */ - qint64 m_iFileSize; /**< TODO: describe */ - QImage m_thumbnail; /**< TODO: describe */ - qint32 m_imageWidth; /**< TODO: describe */ - qint32 m_imageHeight; /**< TODO: describe */ - qint16 m_imageOrientation; /**< TODO: describe */ - QString m_cameraMake; /**< TODO: describe */ - QString m_cameraModel; /**< TODO: describe */ - QDateTime m_dateTime; /**< TODO: describe */ - QString m_fNumber; /**< TODO: describe */ - qint32 m_iso; /**< TODO: describe */ - QString m_flash; /**< TODO: describe */ - qint32 m_flashID; /**< TODO: describe */ - qreal m_focalLength; /**< TODO: describe */ - QString m_lensMake; /**< TODO: describe */ - QString m_lensModel; /**< TODO: describe */ - QString m_exposureTime; /**< TODO: describe */ - qint32 m_exposureBias; /**< TODO: describe */ - QString m_exifVersion; /**< TODO: describe */ - QDateTime m_dateTimeOriginal; /**< TODO: describe */ - QDateTime m_dateTimeDigitized; /**< TODO: describe */ - qint32 m_whiteBalance; /**< TODO: describe */ - qreal m_focalLength35; /**< TODO: describe */ - QString m_gps; /**< TODO: describe */ + qint32 m_iID; /*!< TODO: describe */ + QString m_szFileName; /*!< TODO: describe */ + QString m_szFilePath; /*!< TODO: describe */ + qint64 m_iFileSize; /*!< TODO: describe */ + QImage m_thumbnail; /*!< TODO: describe */ + qint32 m_imageWidth; /*!< TODO: describe */ + qint32 m_imageHeight; /*!< TODO: describe */ + qint16 m_imageOrientation; /*!< TODO: describe */ + QString m_cameraMake; /*!< TODO: describe */ + QString m_cameraModel; /*!< TODO: describe */ + QDateTime m_dateTime; /*!< TODO: describe */ + QString m_fNumber; /*!< TODO: describe */ + qint32 m_iso; /*!< TODO: describe */ + QString m_flash; /*!< TODO: describe */ + qint32 m_flashID; /*!< TODO: describe */ + qreal m_focalLength; /*!< TODO: describe */ + QString m_lensMake; /*!< TODO: describe */ + QString m_lensModel; /*!< TODO: describe */ + QString m_exposureTime; /*!< TODO: describe */ + qint32 m_exposureBias; /*!< TODO: describe */ + QString m_exifVersion; /*!< TODO: describe */ + QDateTime m_dateTimeOriginal; /*!< TODO: describe */ + QDateTime m_dateTimeDigitized; /*!< TODO: describe */ + qint32 m_whiteBalance; /*!< TODO: describe */ + qreal m_focalLength35; /*!< TODO: describe */ + QString m_gps; /*!< TODO: describe */ }; Q_DECLARE_METATYPE(cPicture*) -/** - * @brief - * - */ +/*! + \brief + + \class cPictureList cpicture.h "cpicture.h" +*/ class cPictureList : public QObject, public QList { Q_OBJECT public: - /** - * @brief - * - * @param parent - */ + /*! + \brief + + \fn cPictureList + \param parent + */ explicit cPictureList(QObject *parent = nullptr); - /** - * @brief - * - * @param lpSplashScreen - * @param lpProgressBar - * @return bool - */ - bool load(cSplashScreen* lpSplashScreen, QProgressBar* lpProgressBar = 0); + /*! + \brief - /** - * @brief - * - * @param iID - * @return cPicture - */ + \fn load + \param lpSplashScreen + \param lpProgressBar + \return bool + */ + bool load(cSplashScreen* lpSplashScreen, QProgressBar* lpProgressBar = nullptr); + + /*! + \brief + + \fn add + \param iID + \param bNoCheck + \return cPicture + */ cPicture* add(qint32 iID = -1, bool bNoCheck = false); - /** - * @brief - * - * @param iID - * @return cPicture - */ + /*! + \brief + + \fn find + \param iID + \return cPicture + */ cPicture* find(qint32 iID); signals: diff --git a/cpicturelibrary.cpp b/cpicturelibrary.cpp index c6a302d..35f535e 100644 --- a/cpicturelibrary.cpp +++ b/cpicturelibrary.cpp @@ -1,3 +1,8 @@ +/*! + \file cpicturelibrary.cpp + +*/ + #include "cpicturelibrary.h" #include "common.h" diff --git a/cpicturelibrary.h b/cpicturelibrary.h index 2c98256..ae87133 100644 --- a/cpicturelibrary.h +++ b/cpicturelibrary.h @@ -1,3 +1,8 @@ +/*! + \file cpicturelibrary.h + +*/ + #ifndef CPICTURELIBRARY_H #define CPICTURELIBRARY_H @@ -7,19 +12,21 @@ #include -/** - * @brief - * - */ +/*! + \brief + + \class cPictureLibrary cpicturelibrary.h "cpicturelibrary.h" +*/ class cPictureLibrary : public QObject { Q_OBJECT public: - /** - * @brief - * - * @param parent - */ + /*! + \brief + + \fn cPictureLibrary + \param parent + */ explicit cPictureLibrary(QObject *parent = nullptr); /*! @@ -40,7 +47,7 @@ public: /*! \brief - \fn isValie + \fn isValid \return bool */ bool isValid(); @@ -58,8 +65,8 @@ signals: public slots: private: - QSqlDatabase m_db; /*!< TODO: describe */ - QString m_szRootPath; /*!< TODO: describe */ + QSqlDatabase m_db; /*!< TODO: describe */ + QString m_szRootPath; /*!< TODO: describe */ /*! \brief @@ -79,6 +86,7 @@ private: \brief \fn updateDatabase2 + \param version \return bool */ bool updateDatabase2(qint32 version); @@ -86,6 +94,7 @@ private: \brief \fn updateDatabase3 + \param version \return bool */ bool updateDatabase3(qint32 version); @@ -93,6 +102,7 @@ private: \brief \fn updateDatabase4 + \param version \return bool */ bool updateDatabase4(qint32 version); diff --git a/csplashscreen.cpp b/csplashscreen.cpp index 115cbd2..6f0a358 100644 --- a/csplashscreen.cpp +++ b/csplashscreen.cpp @@ -1,3 +1,8 @@ +/*! + \file csplashscreen.cpp + +*/ + #include "csplashscreen.h" #include "common.h" diff --git a/csplashscreen.h b/csplashscreen.h index 72c09b9..0ebe29b 100644 --- a/csplashscreen.h +++ b/csplashscreen.h @@ -1,3 +1,8 @@ +/*! + \file csplashscreen.h + +*/ + #ifndef CSPLASHSCREEN_H #define CSPLASHSCREEN_H @@ -7,54 +12,66 @@ #include -/** - * @brief - * - */ +/*! + \brief + + \class cSplashScreen csplashscreen.h "csplashscreen.h" +*/ class cSplashScreen : public QSplashScreen { public: cSplashScreen(const QPixmap& pixmap, QFont &font); - /** - * @brief - * - * @param painter - */ + /*! + \brief + + \fn drawContents + \param painter + */ virtual void drawContents(QPainter *painter); - /** - * @brief - * - * @param message - */ + /*! + \brief + + \fn showStatusMessage + \param message + */ void showStatusMessage(const QString &message); - /** - * @brief - * - * @param message - */ + /*! + \brief + + \fn addStatusMessage + \param message + */ void addStatusMessage(const QString &message); - /** - * @brief - * - * @param rect - */ + /*! + \brief + + \fn setMessageRect + \param rect + */ void setMessageRect(QRect rect); - /** - * @brief - * - * @param max - */ + /*! + \brief + + \fn setMax + \param max + */ void setMax(qint32 max); private: - QTextDocument m_textDocument; /**< TODO: describe */ - QString m_szMessage; /**< TODO: describe */ - QRect m_rect; /**< TODO: describe */ - qint32 m_iMax; /**< TODO: describe */ - qint32 m_iProgress; /**< TODO: describe */ + QTextDocument m_textDocument; /*!< TODO: describe */ + QString m_szMessage; /*!< TODO: describe */ + QRect m_rect; /*!< TODO: describe */ + qint32 m_iMax; /*!< TODO: describe */ + qint32 m_iProgress; /*!< TODO: describe */ public slots: + /*! + \brief + + \fn setProgress + \param value + */ void setProgress(int value); }; diff --git a/cthumbnailfilterproxymodel.cpp b/cthumbnailfilterproxymodel.cpp index a969b29..7215b60 100644 --- a/cthumbnailfilterproxymodel.cpp +++ b/cthumbnailfilterproxymodel.cpp @@ -1,3 +1,8 @@ +/*! + \file cthumbnailfilterproxymodel.cpp + +*/ + #include "cthumbnailfilterproxymodel.h" diff --git a/cthumbnailfilterproxymodel.h b/cthumbnailfilterproxymodel.h index 8e944b2..d7cd0e0 100644 --- a/cthumbnailfilterproxymodel.h +++ b/cthumbnailfilterproxymodel.h @@ -1,3 +1,8 @@ +/*! + \file cthumbnailfilterproxymodel.h + +*/ + #ifndef CTHUMBNAILFILTERPROXYMODEL_H #define CTHUMBNAILFILTERPROXYMODEL_H @@ -5,10 +10,11 @@ #include -/** - * @brief - * - */ +/*! + \brief + + \class cThumbnailFilterProxyModel cthumbnailfilterproxymodel.h "cthumbnailfilterproxymodel.h" +*/ class cThumbnailFilterProxyModel : public QSortFilterProxyModel { Q_OBJECT @@ -16,31 +22,33 @@ class cThumbnailFilterProxyModel : public QSortFilterProxyModel public: cThumbnailFilterProxyModel(QObject* parent = nullptr); - /** - * @brief - * - * @return QString - */ + /*! + \brief + + \fn filterPath + */ QString filterPath(); - /** - * @brief - * - * @param szPath - */ + /*! + \brief + + \fn setFilterPath + \param szPath + */ void setFilterPath(const QString& szPath); protected: - /** - * @brief - * - * @param sourceRow - * @param sourceParent - * @return bool - */ + /*! + \brief + + \fn filterAcceptsRow + \param sourceRow + \param sourceParent + \return bool + */ bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override; private: - QString m_szPath; /**< TODO: describe */ + QString m_szPath; /*!< TODO: describe */ }; #endif // CTHUMBNAILFILTERPROXYMODEL_H diff --git a/ctoolboxinfo.cpp b/ctoolboxinfo.cpp index c54351c..088f0a2 100644 --- a/ctoolboxinfo.cpp +++ b/ctoolboxinfo.cpp @@ -1,3 +1,8 @@ +/*! + \file ctoolboxinfo.cpp + +*/ + #include "ctoolboxinfo.h" #include "ui_ctoolboxinfo.h" diff --git a/ctoolboxinfo.h b/ctoolboxinfo.h index c4670cf..f28a488 100644 --- a/ctoolboxinfo.h +++ b/ctoolboxinfo.h @@ -1,3 +1,8 @@ +/*! + \file ctoolboxinfo.h + +*/ + #ifndef CTOOLBOXINFO_H #define CTOOLBOXINFO_H @@ -11,35 +16,39 @@ namespace Ui { class cToolBoxInfo; } -/** - * @brief - * - */ +/*! + \brief + + \class cToolBoxInfo ctoolboxinfo.h "ctoolboxinfo.h" +*/ class cToolBoxInfo : public QWidget { Q_OBJECT public: - /** - * @brief - * - * @param parent - */ + /*! + \brief + + \fn cToolBoxInfo + \param parent + */ explicit cToolBoxInfo(QWidget *parent = nullptr); - /** - * @brief - * - */ + /*! + \brief + + \fn ~cToolBoxInfo + */ ~cToolBoxInfo(); - /** - * @brief - * - * @param lpPicture - */ + /*! + \brief + + \fn setPicture + \param lpPicture + */ void setPicture(cPicture* lpPicture); private: - Ui::cToolBoxInfo* ui; /**< TODO: describe */ + Ui::cToolBoxInfo* ui; /*!< TODO: describe */ }; #endif // CTOOLBOXINFO_H diff --git a/main.cpp b/main.cpp index 808aee6..e4e769d 100644 --- a/main.cpp +++ b/main.cpp @@ -1,3 +1,8 @@ +/*! + \file main.cpp + +*/ + #include "cmainwindow.h" #include