added Doxygen

This commit is contained in:
2020-02-06 10:05:56 +01:00
parent 92d2cb9a7b
commit 14125520ef
12 changed files with 2798 additions and 26 deletions
+2511
View File
File diff suppressed because it is too large Load Diff
+5
View File
@@ -3,6 +3,11 @@
*/
/*!
\file cexif.cpp
*/
#include "cexif.h"
#include "common.h"
+5
View File
@@ -1,3 +1,8 @@
/*!
\file cfilebrowser.cpp
*/
#include "cfilebrowser.h"
#include "ui_cfilebrowser.h"
+58 -14
View File
@@ -1,3 +1,8 @@
/*!
\file cfilebrowser.h
*/
#ifndef CFILEBROWSER_H
#define CFILEBROWSER_H
@@ -22,39 +27,78 @@ namespace Ui {
class cFileBrowser;
}
/*!
\brief
\class cFileBrowser cfilebrowser.h "cfilebrowser.h"
*/
class cFileBrowser : public QWidget
{
Q_OBJECT
public:
/*!
\brief
\fn cFileBrowser
\param lpProgressBar
\param lpImageFormats
\param parent
*/
explicit cFileBrowser(QProgressBar* lpProgressBar, QList<IMAGEFORMAT>* lpImageFormats, QWidget *parent = nullptr);
/*!
\brief
\fn ~cFileBrowser
*/
~cFileBrowser();
private:
Ui::cFileBrowser* ui;
QFileSystemModel m_directoryListModel;
QStandardItemModel* m_lpFileListModel;
QStandardItemModel* m_lpSelectedListModel;
QProgressBar* m_lpProgressBar;
QList<IMAGEFORMAT>* m_lpImageFormats;
Ui::cFileBrowser* ui; /*!< TODO: describe */
QFileSystemModel m_directoryListModel; /*!< TODO: describe */
QStandardItemModel* m_lpFileListModel; /*!< TODO: describe */
QStandardItemModel* m_lpSelectedListModel; /*!< TODO: describe */
QProgressBar* m_lpProgressBar; /*!< TODO: describe */
QList<IMAGEFORMAT>* m_lpImageFormats; /*!< TODO: describe */
cEXIFTagList m_exifTAGList;
cEXIFCompressionList m_exifCompressionList;
cEXIFLightSourceList m_exifLightSourceList;
cEXIFFlashList m_exifFlashList;
cEXIFTagList m_exifTAGList; /*!< TODO: describe */
cEXIFCompressionList m_exifCompressionList; /*!< TODO: describe */
cEXIFLightSourceList m_exifLightSourceList; /*!< TODO: describe */
cEXIFFlashList m_exifFlashList; /*!< TODO: describe */
cIPTCTagList m_iptcTagList;
cIPTCTagList m_iptcTagList; /*!< TODO: describe */
cXMPTagList m_xmpTagList;
cXMPTagList m_xmpTagList; /*!< TODO: describe */
QSqlDatabase m_cacheDB;
QSqlDatabase m_cacheDB; /*!< TODO: describe */
bool m_working;
bool m_working; /*!< TODO: describe */
/*!
\brief
\fn addFile
\param fileInfo
*/
void addFile(const QFileInfo& fileInfo);
private slots:
/*!
\brief
\fn onDirectoryChanged
\param selected
\param deselected
*/
void onDirectoryChanged(const QItemSelection& selected, const QItemSelection& deselected);
/*!
\brief
\fn onCountChanged
\param fileName
\param pixmap
\param count
*/
void onCountChanged(const QString& fileName, QPixmap pixmap, int count);
};
+5
View File
@@ -1,3 +1,8 @@
/*!
\file cfileviewer.cpp
*/
#include "common.h"
#include "cfileviewer.h"
+88 -2
View File
@@ -1,3 +1,8 @@
/*!
\file cfileviewer.h
*/
#ifndef CFILEVIEWER_H
#define CFILEVIEWER_H
@@ -11,39 +16,120 @@ namespace Ui {
class cFileViewer;
}
/*!
\brief
\class cFileViewer cfileviewer.h "cfileviewer.h"
*/
class cFileViewer : public QWidget
{
Q_OBJECT
public:
/*!
\brief
\fn cFileViewer
\param parent
*/
explicit cFileViewer(QWidget *parent = nullptr);
/*!
\brief
\fn ~cFileViewer
*/
~cFileViewer();
/*!
\brief
\fn setImage
\param fileName
\param image
*/
void setImage(const QString& fileName, const QPixmap& image);
/*!
\brief
\fn image
\return QPixmap
*/
QPixmap image();
/*!
\brief
\fn fileName
\return QString
*/
QString fileName();
/*!
\brief
\fn setCount
\param count
*/
void setCount(qint32 count);
/*!
\brief
\fn count
\return qint32
*/
qint32 count();
private:
Ui::cFileViewer* ui;
QString m_fileName;
Ui::cFileViewer* ui; /*!< TODO: describe */
QString m_fileName; /*!< TODO: describe */
public slots:
/*!
\brief
\fn onCountChanged
\param i
*/
void onCountChanged(int i);
signals:
/*!
\brief
\fn countChanged
\param fileName
\param pixmap
\param i
*/
void countChanged(const QString& fileName, QPixmap pixmap, int i);
};
Q_DECLARE_METATYPE(cFileViewer*)
/*!
\brief
\class cFileViewerList cfileviewer.h "cfileviewer.h"
*/
class cFileViewerList : public QList<cFileViewer*>
{
public:
/*!
\brief
\fn add
\param fileName
\param image
\return cFileViewer
*/
cFileViewer* add(const QString& fileName, const QPixmap& image);
/*!
\brief
\fn find
\param fileName
\return cFileViewer
*/
cFileViewer* find(const QString& fileName);
};
+5
View File
@@ -1,3 +1,8 @@
/*!
\file cmainwindow.cpp
*/
#include "common.h"
#include "cmainwindow.h"
+61 -5
View File
@@ -1,3 +1,8 @@
/*!
\file cmainwindow.h
*/
#ifndef CMAINWINDOW_H
#define CMAINWINDOW_H
@@ -17,32 +22,83 @@ namespace Ui { class cMainWindow; }
QT_END_NAMESPACE
/*!
\brief
\class cMainWindow cmainwindow.h "cmainwindow.h"
*/
class cMainWindow : public QMainWindow
{
Q_OBJECT
public:
cMainWindow(cSplashScreen* lpSplashScreen, QWidget *parent = nullptr);
/*!
\brief
\fn ~cMainWindow
*/
~cMainWindow();
private:
Ui::cMainWindow* ui;
cSplashScreen* m_lpSplashScreen;
QProgressBar* m_lpProgressBar;
Ui::cMainWindow* ui; /*!< TODO: describe */
cSplashScreen* m_lpSplashScreen; /*!< TODO: describe */
QProgressBar* m_lpProgressBar; /*!< TODO: describe */
cFileBrowser* m_lpFileBrowser;
cFileBrowser* m_lpFileBrowser; /*!< TODO: describe */
QList<IMAGEFORMAT> m_imageFormats;
QList<IMAGEFORMAT> m_imageFormats; /*!< TODO: describe */
/*!
\brief
\fn initUI
*/
void initUI();
/*!
\brief
\fn createActions
*/
void createActions();
/*!
\brief
\fn createFileActions
*/
void createFileActions();
/*!
\brief
\fn createContextActions
*/
void createContextActions();
/*!
\brief
\fn setImageFormats
*/
void setImageFormats();
/*!
\brief
\fn addImageFormat
\param shortName
\param description
\param extension
\param readList
\param writeList
*/
void addImageFormat(const QString& shortName, const QString& description, const QString& extension, QList<QByteArray>& readList, QList<QByteArray>& writeList);
protected:
/*!
\brief
\fn closeEvent
\param event
*/
void closeEvent(QCloseEvent* event);
};
#endif // CMAINWINDOW_H
+5
View File
@@ -1,3 +1,8 @@
/*!
\file common.cpp
*/
#include "common.h"
#include <QImage>
+49 -5
View File
@@ -1,3 +1,8 @@
/*!
\file common.h
*/
#ifndef COMMON_H
#define COMMON_H
@@ -18,13 +23,18 @@
#endif
/*!
\brief
\class tagIMAGEFORMAT common.h "common.h"
*/
typedef struct tagIMAGEFORMAT
{
QString shortName;
QString description;
QString extension;
bool read;
bool write;
QString shortName; /*!< TODO: describe */
QString description; /*!< TODO: describe */
QString extension; /*!< TODO: describe */
bool read; /*!< TODO: describe */
bool write; /*!< TODO: describe */
/*!
\brief
@@ -32,12 +42,46 @@ typedef struct tagIMAGEFORMAT
} IMAGEFORMAT;
/*!
\brief
\fn generateReadList
\param imageFormats
\return QStringList
*/
QStringList generateReadList(const QList<IMAGEFORMAT>& imageFormats);
/*!
\brief
\fn generateWriteList
\param imageFormats
\return QStringList
*/
QStringList generateWriteList(const QList<IMAGEFORMAT>& imageFormats);
/*!
\brief
\fn blob2Image
\param ba
\return QImage
*/
QImage blob2Image(const QByteArray& ba);
/*!
\brief
\fn image2Blob
\param image
\return QByteArray
*/
QByteArray image2Blob(const QImage& image);
/*!
\brief
\fn userDir
\return QString
*/
QString userDir();
+5
View File
@@ -1,3 +1,8 @@
/*!
\file main.cpp
*/
#include "cmainwindow.h"
#include <QApplication>
+1
View File
@@ -80,4 +80,5 @@ RESOURCES += \
qdarkstyle/style.qrc
DISTFILES += \
Doxyfile \
picturePrint.db