From 2aabbc0a798158e54a2ddff1dd65a62d45fab55a Mon Sep 17 00:00:00 2001 From: Herwig Birke Date: Wed, 16 May 2018 10:51:03 +0200 Subject: [PATCH] . --- cchapterwindow.h | 6 ++++ ccharacter.h | 6 ++-- ccheckbox.h | 6 ++++ ccombobox.h | 6 ++++ cdateedit.h | 6 ++++ cdatetimeedit.h | 6 ++++ cdoublespinbox.h | 6 ++++ cimage.h | 14 +++++++- clineedit.h | 6 ++++ cmainwindow.h | 4 +-- cpartwindow.h | 6 ++++ cpropertieswindow.h | 80 +++++++++++++++++++++++++++++++++++++++++++-- cradiobutton.h | 6 ++++ crecherchewindow.h | 6 ++++ cscene.h | 10 +++--- cscenewindow.h | 5 +++ ctextdocument.h | 6 ++++ ctextedit.h | 6 ++++ ctreeview.h | 6 ++++ cwidget.h | 16 ++++----- 20 files changed, 191 insertions(+), 22 deletions(-) diff --git a/cchapterwindow.h b/cchapterwindow.h index 87264d7..5430d3c 100644 --- a/cchapterwindow.h +++ b/cchapterwindow.h @@ -66,6 +66,12 @@ private slots: */ void onSceneDoubleClicked(const QModelIndex& index); + /*! + \brief + + \fn onNameChanged + \param szName + */ void onNameChanged(const QString& szName); /*! \brief diff --git a/ccharacter.h b/ccharacter.h index 815faeb..4df56f8 100644 --- a/ccharacter.h +++ b/ccharacter.h @@ -34,9 +34,9 @@ public: */ enum GENDER { - GENDER_undefined = 0, - GENDER_male = 1, - GENDER_female = 2, + GENDER_undefined = 0, /*!< TODO: describe */ + GENDER_male = 1, /*!< TODO: describe */ + GENDER_female = 2, /*!< TODO: describe */ }; /*! diff --git a/ccheckbox.h b/ccheckbox.h index fab01d2..370033f 100644 --- a/ccheckbox.h +++ b/ccheckbox.h @@ -21,6 +21,12 @@ class cCheckBox : public QCheckBox Q_OBJECT public: + /*! + \brief + + \fn cCheckBox + \param parent + */ cCheckBox(QWidget* parent = Q_NULLPTR); signals: diff --git a/ccombobox.h b/ccombobox.h index 2d9c824..a04de41 100644 --- a/ccombobox.h +++ b/ccombobox.h @@ -21,6 +21,12 @@ class cComboBox : public QComboBox Q_OBJECT public: + /*! + \brief + + \fn cComboBox + \param parent + */ cComboBox(QWidget* parent = Q_NULLPTR); signals: diff --git a/cdateedit.h b/cdateedit.h index 5b874cf..45837a6 100644 --- a/cdateedit.h +++ b/cdateedit.h @@ -21,6 +21,12 @@ class cDateEdit : public QDateEdit Q_OBJECT public: + /*! + \brief + + \fn cDateEdit + \param parent + */ cDateEdit(QWidget* parent = Q_NULLPTR); signals: diff --git a/cdatetimeedit.h b/cdatetimeedit.h index 1bcc98b..35f5ab7 100644 --- a/cdatetimeedit.h +++ b/cdatetimeedit.h @@ -21,6 +21,12 @@ class cDateTimeEdit : public QDateTimeEdit Q_OBJECT public: + /*! + \brief + + \fn cDateTimeEdit + \param parent + */ cDateTimeEdit(QWidget* parent = Q_NULLPTR); signals: diff --git a/cdoublespinbox.h b/cdoublespinbox.h index 8a3ce71..1c69816 100644 --- a/cdoublespinbox.h +++ b/cdoublespinbox.h @@ -21,6 +21,12 @@ class cDoubleSpinBox : public QDoubleSpinBox Q_OBJECT public: + /*! + \brief + + \fn cDoubleSpinBox + \param parent + */ cDoubleSpinBox(QWidget* parent = Q_NULLPTR); signals: diff --git a/cimage.h b/cimage.h index e266543..ed0f037 100644 --- a/cimage.h +++ b/cimage.h @@ -86,14 +86,26 @@ public: */ cTextDocument* description(); + /*! + \brief + + \fn setImage + \param image + */ void setImage(const QPixmap& image); + /*! + \brief + + \fn image + \return QPixmap + */ QPixmap image(); private: qint32 m_iID; /*!< TODO: describe */ QString m_szName; /*!< TODO: describe */ QString m_szType; /*!< TODO: describe */ cTextDocument* m_lpDescription; /*!< TODO: describe */ - QPixmap m_image; + QPixmap m_image; /*!< TODO: describe */ }; Q_DECLARE_METATYPE(cImage*) diff --git a/clineedit.h b/clineedit.h index 2a0914d..5ad1649 100644 --- a/clineedit.h +++ b/clineedit.h @@ -21,6 +21,12 @@ class cLineEdit : public QLineEdit Q_OBJECT public: + /*! + \brief + + \fn cLineEdit + \param parent + */ cLineEdit(QWidget* parent = Q_NULLPTR); signals: diff --git a/cmainwindow.h b/cmainwindow.h index a00fb24..f4c1410 100644 --- a/cmainwindow.h +++ b/cmainwindow.h @@ -677,8 +677,8 @@ private: QAction* m_lpSeparatorRecent; - enum { MaxRecentFiles = 5 }; - QAction* m_lpActionRecentFile[MaxRecentFiles]; + enum { MaxRecentFiles = 5 }; /*!< TODO: describe */ + QAction* m_lpActionRecentFile[MaxRecentFiles]; /*!< TODO: describe */ QActionGroup* m_lpAlignGroup; /*!< TODO: describe */ diff --git a/cpartwindow.h b/cpartwindow.h index 6e22a25..43d9e6a 100644 --- a/cpartwindow.h +++ b/cpartwindow.h @@ -65,6 +65,12 @@ private slots: */ void onChapterDoubleClicked(const QModelIndex& index); + /*! + \brief + + \fn onNameChanged + \param szName + */ void onNameChanged(const QString& szName); /*! \brief diff --git a/cpropertieswindow.h b/cpropertieswindow.h index 84cd662..e05f3a1 100644 --- a/cpropertieswindow.h +++ b/cpropertieswindow.h @@ -15,31 +15,105 @@ namespace Ui { class cPropertiesWindow; } +/*! + \brief + + \class cPropertiesWindow cpropertieswindow.h "cpropertieswindow.h" +*/ class cPropertiesWindow : public cMDISubWindow { Q_OBJECT public: + /*! + \brief + + \fn cPropertiesWindow + \param parent + */ explicit cPropertiesWindow(QWidget *parent = 0); + /*! + \brief + + \fn ~cPropertiesWindow + */ ~cPropertiesWindow(); + /*! + \brief + + \fn setBook + \param lpBook + */ void setBook(cBook* lpBook); + /*! + \brief + + \fn book + \return cBook + */ cBook* book(); private slots: + /*! + \brief + + \fn onTitleChanged + \param szName + */ void onTitleChanged(const QString& szName); + /*! + \brief + + \fn onSubTitleChanged + \param szName + */ void onSubTitleChanged(const QString& szName); + /*! + \brief + + \fn onAuthorChanged + \param szName + */ void onAuthorChanged(const QString& szName); + /*! + \brief + + \fn onShortDescriptionChanged + */ void onShortDescriptionChanged(); + /*! + \brief + + \fn onDescriptionChanged + */ void onDescriptionChanged(); + /*! + \brief + + \fn onStartedAtChanged + \param dateTime + */ void onStartedAtChanged(const QDateTime& dateTime); + /*! + \brief + + \fn onFinishedAtChanged + \param dateTime + */ void onFinishedAtChanged(const QDateTime& dateTime); + /*! + \brief + + \fn onTargetDateChanged + \param dateTime + */ void onTargetDateChanged(const QDateTime& dateTime); private: - Ui::cPropertiesWindow* ui; - cMainWindow* m_lpMainWindow; - cBook* m_lpBook; + Ui::cPropertiesWindow* ui; /*!< TODO: describe */ + cMainWindow* m_lpMainWindow; /*!< TODO: describe */ + cBook* m_lpBook; /*!< TODO: describe */ }; #endif // CPROPERTIESWINDOW_H diff --git a/cradiobutton.h b/cradiobutton.h index 4913d3f..1c8d13b 100644 --- a/cradiobutton.h +++ b/cradiobutton.h @@ -21,6 +21,12 @@ class cRadioButton : public QRadioButton Q_OBJECT public: + /*! + \brief + + \fn cRadioButton + \param parent + */ cRadioButton(QWidget* parent = Q_NULLPTR); signals: diff --git a/crecherchewindow.h b/crecherchewindow.h index 17a0b0a..4406211 100644 --- a/crecherchewindow.h +++ b/crecherchewindow.h @@ -77,6 +77,12 @@ private slots: */ void onObjectDoubleClicked(const QModelIndex& index); + /*! + \brief + + \fn onNameChanged + \param szName + */ void onNameChanged(const QString& szName); /*! \brief diff --git a/cscene.h b/cscene.h index 2f66cfc..0068720 100644 --- a/cscene.h +++ b/cscene.h @@ -38,11 +38,11 @@ public: */ enum STATE { - STATE_unknown = 0, - STATE_init = 1, - STATE_progress = 2, - STATE_delayed = 3, - STATE_finished = 4, + STATE_unknown = 0, /*!< TODO: describe */ + STATE_init = 1, /*!< TODO: describe */ + STATE_progress = 2, /*!< TODO: describe */ + STATE_delayed = 3, /*!< TODO: describe */ + STATE_finished = 4, /*!< TODO: describe */ }; /*! diff --git a/cscenewindow.h b/cscenewindow.h index 9f8df42..e7bc6a1 100644 --- a/cscenewindow.h +++ b/cscenewindow.h @@ -79,6 +79,11 @@ private slots: */ void onObjectDoubleClicked(const QModelIndex& index); + /*! + \brief + + \fn onNameChanged + */ void onNameChanged(const QString& szName); /*! \brief diff --git a/ctextdocument.h b/ctextdocument.h index 8ee965d..acfcbd2 100644 --- a/ctextdocument.h +++ b/ctextdocument.h @@ -29,6 +29,12 @@ QT_END_NAMESPACE class cTextDocument : public QTextDocument { public: + /*! + \brief + + \fn cTextDocument + \param parent + */ cTextDocument(QObject *parent = Q_NULLPTR); /*! \brief diff --git a/ctextedit.h b/ctextedit.h index 43e67ae..1694f93 100644 --- a/ctextedit.h +++ b/ctextedit.h @@ -23,6 +23,12 @@ class cTextEdit : public QTextEdit Q_OBJECT public: + /*! + \brief + + \fn cTextEdit + \param parent + */ cTextEdit(QWidget* parent = Q_NULLPTR); /*! \brief diff --git a/ctreeview.h b/ctreeview.h index 8c7f5cf..0f4c5d8 100644 --- a/ctreeview.h +++ b/ctreeview.h @@ -21,6 +21,12 @@ class cTreeView : public QTreeView Q_OBJECT public: + /*! + \brief + + \fn cTreeView + \param parent + */ cTreeView(QWidget* parent = Q_NULLPTR); signals: diff --git a/cwidget.h b/cwidget.h index bcbf0a0..c31ca6b 100644 --- a/cwidget.h +++ b/cwidget.h @@ -31,15 +31,15 @@ public: */ enum TYPE { - TYPE_unknown = 0, - TYPE_part = 1, - TYPE_chapter = 2, - TYPE_scene = 3, - TYPE_character = 4, + TYPE_unknown = 0, /*!< TODO: describe */ + TYPE_part = 1, /*!< TODO: describe */ + TYPE_chapter = 2, /*!< TODO: describe */ + TYPE_scene = 3, /*!< TODO: describe */ + TYPE_character = 4, /*!< TODO: describe */ TYPE_object = 5, /*!< TODO: describe */ - TYPE_place = 6, - TYPE_recherche = 7, - TYPE_properties = 8, + TYPE_place = 6, /*!< TODO: describe */ + TYPE_recherche = 7, /*!< TODO: describe */ + TYPE_properties = 8, /*!< TODO: describe */ }; /*!