Fix some doxygen issues (~100)

This commit is contained in:
Simon De Backer
2020-08-18 20:07:55 +02:00
parent b5f212418c
commit 790cdc5229
22 changed files with 205 additions and 154 deletions

View File

@@ -26,13 +26,17 @@
/**
@brief The PropertiesEditorDialog class
Create a dialog to edit some properties of a thing.
Only create a instance of this class and call exec, all is done for you in this class.
The first argument (a template) must be a subclass of QWidget and provide the 3 methods bellow :
Only create a instance of this class and call exec,
all is done for you in this class.
The first argument (a template) must be a subclass
of QWidget and provide the 3 methods bellow :
QString::title()
void::apply()
void::reset()
You can subclass the interface PropertiesEditorWidget who provide all this methods.
This dialog take ownership of the editor, so the editor will be deleted by this dialog
You can subclass the interface PropertiesEditorWidget
who provide all this methods.
This dialog take ownership of the editor,
so the editor will be deleted by this dialog
*/
class PropertiesEditorDialog : public QDialog
{
@@ -42,12 +46,13 @@ class PropertiesEditorDialog : public QDialog
PropertiesEditorDialog(T editor, QWidget *parent = nullptr) :
QDialog (parent)
{
//Set dialog title
//Set dialog title
setWindowTitle(editor->title());
//Reparent the editor, to be deleted at the same time of this dialog
// Reparent the editor,
// to be deleted at the same time of this dialog
editor->setParent(this);
//Build the dialog
//Build the dialog
QVBoxLayout *vlayout = new QVBoxLayout(this);
vlayout->addWidget(editor);
QDialogButtonBox *button_box = new QDialogButtonBox (QDialogButtonBox::Apply | QDialogButtonBox::Cancel | QDialogButtonBox::Reset, this);