kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2026-03-05 05:19:59 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix some doxygen issues (~100)

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

16
sources/SearchAndReplace/searchandreplaceworker.cpp
View File

@@ -33,7 +33,7 @@ SearchAndReplaceWorker::SearchAndReplaceWorker()
/**
@brief SearchAndReplaceWorker::replaceDiagram
Replace all properties of each diagram in @diagram_list,
Replace all properties of each diagram in diagram_list,
by the current titleblock propertie of this worker
@param diagram_list, list of diagram to be changed,
all diagrams must belong to the same project;
@@ -93,7 +93,7 @@ void SearchAndReplaceWorker::replaceDiagram(Diagram *diagram)
/**
@brief SearchAndReplaceWorker::replaceElement
Replace all properties of each elements in @list
Replace all properties of each elements in list
All element must belong to the same project,
if not this function do nothing.
All change are made through a undo command append
@@ -151,7 +151,7 @@ void SearchAndReplaceWorker::replaceElement(Element *element)
/**
@brief SearchAndReplaceWorker::replaceIndiText
Replace all displayed text of independent text of @list
Replace all displayed text of independent text of list
Each must belong to the same project, if not this function do nothing
@param list
*/
@@ -187,7 +187,7 @@ void SearchAndReplaceWorker::replaceIndiText(IndependentTextItem *text)
/**
@brief SearchAndReplaceWorker::replaceConductor
Replace all properties of each conductor in @list
Replace all properties of each conductor in list
All conductor must belong to the same project,
if not this function do nothing.
All change are made through a undo command append
@@ -394,7 +394,7 @@ ConductorProperties SearchAndReplaceWorker::invalidConductorProperties()
/**
@brief SearchAndReplaceWorker::applyChange
@param original : the original properties
@param change : the change properties, to be merged with @original
@param change : the change properties, to be merged with original
@return a new conductor properties with the change applyed.
*/
ConductorProperties SearchAndReplaceWorker::applyChange(const ConductorProperties &original, const ConductorProperties &change)
@@ -443,7 +443,7 @@ QString SearchAndReplaceWorker::applyChange(const QString &original, const QStri
@brief SearchAndReplaceWorker::replaceAdvanced
@param diagram
@return the titleblock properties with the change applied,
according to the state of @m_advanced_struct
according to the state of m_advanced_struct
*/
TitleBlockProperties SearchAndReplaceWorker::replaceAdvanced(Diagram *diagram)
{
@@ -469,7 +469,7 @@ TitleBlockProperties SearchAndReplaceWorker::replaceAdvanced(Diagram *diagram)
@brief SearchAndReplaceWorker::replaceAdvanced
@param element
@return The diagram context with the change applied,
according to the state of @m_advanced_struct
according to the state of m_advanced_struct
*/
DiagramContext SearchAndReplaceWorker::replaceAdvanced(Element *element)
{
@@ -494,7 +494,7 @@ DiagramContext SearchAndReplaceWorker::replaceAdvanced(Element *element)
@brief SearchAndReplaceWorker::replaceAdvanced
@param conductor
@return the conductor properties with the change applied,
according to the state of @m_advanced_struct
according to the state of m_advanced_struct
*/
ConductorProperties SearchAndReplaceWorker::replaceAdvanced(Conductor *conductor)
{

12
sources/SearchAndReplace/ui/searchandreplacewidget.cpp
View File

@@ -309,7 +309,7 @@ void SearchAndReplaceWidget::fillItemsList()
/**
@brief SearchAndReplaceWidget::addElement
Add a tree widget item for @element
Add a tree widget item for element
@param element
*/
void SearchAndReplaceWidget::addElement(Element *element)
@@ -434,7 +434,7 @@ void SearchAndReplaceWidget::search()
/**
@brief SearchAndReplaceWidget::setVisibleAllParents
Set visible all parents of @item until the invisible root item
Set visible all parents of item until the invisible root item
@param item
@param expend_parent
*/
@@ -452,8 +452,8 @@ void SearchAndReplaceWidget::setVisibleAllParents(QTreeWidgetItem *item,
/**
@brief SearchAndReplaceWidget::nextItem
@param item : find the next item from @item,
if @item is nullptr, start the search for the root of the tree
@param item : find the next item from item,
if item is nullptr, start the search for the root of the tree
@param flags
@return the next item according to flag
or nullptr if there is not a next item
@@ -485,8 +485,8 @@ QTreeWidgetItem *SearchAndReplaceWidget::nextItem(
/**
@brief SearchAndReplaceWidget::previousItem
@param item : find the previous item from @item,
if @item is nullptr, start the search for the root of the tree
@param item : find the previous item from item,
if item is nullptr, start the search for the root of the tree
@param flags
@return the previous item according to flag
or nullptr if there is not a previous item