Fix some doxygen issues

This commit is contained in:
Simon De Backer
2020-08-18 21:28:52 +02:00
parent ef15013715
commit 8e956df8d8
33 changed files with 204 additions and 159 deletions

View File

@@ -49,9 +49,11 @@ ElementPropertiesWidget::ElementPropertiesWidget(Element *elmt, QWidget *parent)
/**
@brief ElementPropertiesWidget::ElementPropertiesWidget
Same as default constructor, the edited element, is the parent element of @text.
The only difference with default constructor, is that the current tab is the tab for dynamic texts,
and the item in the tree that represent @text is expanded and selected.
Same as default constructor, the edited element,
is the parent element of text.
The only difference with default constructor,
is that the current tab is the tab for dynamic texts,
and the item in the tree that represent text is expanded and selected.
@param text
@param parent
*/
@@ -70,9 +72,11 @@ ElementPropertiesWidget::ElementPropertiesWidget(DynamicElementTextItem *text, Q
/**
@brief ElementPropertiesWidget::ElementPropertiesWidget
Same as default constructor, the edited element, is the parent element of @group.
The only difference with default constructor, is that the current tab is the tab for dynamic texts,
and the item in the tree that represent @group is expanded and selected.
Same as default constructor, the edited element,
is the parent element of group.
The only difference with default constructor,
is that the current tab is the tab for dynamic texts,
and the item in the tree that represent group is expanded and selected.
@param group
@param parent
*/
@@ -92,7 +96,7 @@ ElementPropertiesWidget::ElementPropertiesWidget(ElementTextItemGroup *group, QW
/**
@brief ElementPropertiesWidget::setElement
Set @element to be the edited element
Set element to be the edited element
@param element
*/
void ElementPropertiesWidget::setElement(Element *element)
@@ -119,8 +123,11 @@ void ElementPropertiesWidget::setElement(Element *element)
/**
@brief ElementPropertiesWidget::setDynamicText
convenience function: same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @text.
Set the dynamics text tab as current tab, expand and select the item that represent @text
convenience function:
same as call : ElementPropertiesWidget::setElement,
with parameter the parent element of text.
Set the dynamics text tab as current tab,
expand and select the item that represent text
@param text
*/
void ElementPropertiesWidget::setDynamicText(DynamicElementTextItem *text)
@@ -142,8 +149,11 @@ void ElementPropertiesWidget::setDynamicText(DynamicElementTextItem *text)
/**
@brief ElementPropertiesWidget::setTextsGroup
Conveniance function : same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @group.
Set the dynamics text tab as current tab, expand and select the item that represent @group
Conveniance function :
same as call : ElementPropertiesWidget::setElement,
with parameter the parent element of group.
Set the dynamics text tab as current tab,
expand and select the item that represent group
@param group
*/
void ElementPropertiesWidget::setTextsGroup(ElementTextItemGroup *group)