doxygen documentation

2019-11-12 09:59:37 +01:00
parent 30a726f8a6
commit eee85fcff5
14 changed files with 3174 additions and 34 deletions
@@ -1,3 +1,8 @@
+/*!
+ \file cfiledialog.h
+
+*/
+
 #ifndef CFILEDIALOG_H
 #define CFILEDIALOG_H

@@ -6,19 +11,53 @@
 #include <QCheckBox>


+/*!
+ \brief
+
+ \class cFileDialog cfiledialog.h "cfiledialog.h"
+*/
 class cFileDialog : public QFileDialog
 {
 public:
 	cFileDialog(QWidget *parent = nullptr, const QString &caption = QString(), const QString &directory = QString(), const QString &filter = QString());
+	/*!
+	 \brief
+
+	 \fn cFileDialog
+	 \param parent
+	 \param flags
+	*/
 	cFileDialog(QWidget *parent, Qt::WindowFlags flags);

+	/*!
+	 \brief
+
+	 \fn addCheckbox
+	*/
 	void		addCheckbox();
+	/*!
+	 \brief
+
+	 \fn setChecked
+	 \param check
+	*/
 	void		setChecked(bool check);
+	/*!
+	 \brief
+
+	 \fn checked
+	 \return bool
+	*/
 	bool		checked();

 private:
-	QCheckBox*	m_lpCheckBox;
+	QCheckBox*	m_lpCheckBox;		/*!< TODO: describe */

+	/*!
+	 \brief
+
+	 \fn init
+	*/
 	void		init();
 };