kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2025-12-21 16:50:53 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix some doxygen issues

Browse Source
This commit is contained in:
Simon De Backer
2020-08-19 21:24:48 +02:00
parent f5725531c2
commit 666f20856e
21 changed files with 149 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
sources/titleblock/templatecellwidget.cpp
View File

@@ -26,8 +26,10 @@
#include "qetinformation.h"
/**
@brief TitleBlockTemplateCellWidget::TitleBlockTemplateCellWidget
Constructor
@param parent Parent QWidget
@param parent_template : TitleBlockTemplate
@param parent : QWidget
*/
TitleBlockTemplateCellWidget::TitleBlockTemplateCellWidget(TitleBlockTemplate *parent_template, QWidget *parent) :
QWidget(parent),

4
sources/titleblock/templatelocation.cpp
View File

@@ -56,8 +56,8 @@ TitleBlockTemplatesCollection *TitleBlockTemplateLocation::parentCollection() co
}
/**
@param project The new parent collection of the template, or 0 if none
applies.
@brief TitleBlockTemplateLocation::setParentCollection
@param collection : TitleBlockTemplatesCollection
*/
void TitleBlockTemplateLocation::setParentCollection(TitleBlockTemplatesCollection *collection) {
collection_ = collection;

12
sources/titleblock/templatelocationchooser.cpp
View File

@@ -21,9 +21,10 @@
#include "templatescollection.h"
/**
@brief TitleBlockTemplateLocationChooser::TitleBlockTemplateLocationChooser
Constructor
@param location Initial location displayed by the widget
@param widget Parent QWidget
@param location : Initial location displayed by the widget
@param parent : Parent QWidget
*/
TitleBlockTemplateLocationChooser::TitleBlockTemplateLocationChooser(
const TitleBlockTemplateLocation &location,
@@ -99,8 +100,11 @@ void TitleBlockTemplateLocationChooser::init() {
}
/**
@param coll A Title block templates collection which we want to know the index within the combo box of this dialog.
@return -1 if the collection is unknown to this dialog, or the index of \a coll
@brief TitleBlockTemplateLocationChooser::indexForCollection
@param coll : A Title block templates collection
which we want to know the index within the combo box of this dialog.
@return -1 if the collection is unknown to this dialog,
or the index of \a coll
*/
int TitleBlockTemplateLocationChooser::indexForCollection(TitleBlockTemplatesCollection *coll) const {
QList<int> indexes = collections_index_.keys(coll);

5
sources/titleblock/templatelocationsaver.cpp
View File

@@ -21,9 +21,10 @@
#include "templatescollection.h"
/**
@brief TitleBlockTemplateLocationSaver::TitleBlockTemplateLocationSaver
Constructor
@param location Initial location displayed by the widget
@param widget Parent QWidget
@param location
@param parent : QWidget
*/
TitleBlockTemplateLocationSaver::TitleBlockTemplateLocationSaver(
const TitleBlockTemplateLocation &location,

3
sources/titleblock/templatescollection.cpp
View File

@@ -44,7 +44,8 @@ QString TitleBlockTemplatesCollection::title() const {
}
/**
@oaram title New title for this collection
@brief TitleBlockTemplatesCollection::setTitle
@param title : New title for this collection
*/
void TitleBlockTemplatesCollection::setTitle(const QString &title) {
title_ = title;

27
sources/titleblock/templateview.cpp
View File

@@ -52,7 +52,8 @@ TitleBlockTemplateView::TitleBlockTemplateView(QWidget *parent) :
}
/**
Constructor
@brief TitleBlockTemplateView::TitleBlockTemplateView
@param scene
@param parent Parent QWidget.
*/
TitleBlockTemplateView::TitleBlockTemplateView(QGraphicsScene *scene, QWidget *parent) :
@@ -444,9 +445,13 @@ TitleBlockTemplateCellsSet TitleBlockTemplateView::cells(const QRectF &rect) con
}
/**
@param can_merge If non-zero, will be changed to reflect whether selected cells may be merged
@param can_merge If non-zero, will be changed to reflect whether selected cells may be splitted
@param count If non-zero, will be changed to reflect the number of selected cells
@brief TitleBlockTemplateView::analyzeSelectedCells
@param can_merge :
If non-zero, will be changed to reflect whether selected cells may be merged
@param can_split :
If non-zero, will be changed to reflect whether selected cells may be splitted
@param count :
If non-zero, will be changed to reflect the number of selected cells
*/
void TitleBlockTemplateView::analyzeSelectedCells(bool *can_merge, bool *can_split, int *count) {
if (!can_merge && !can_split) return;
@@ -822,8 +827,12 @@ bool TitleBlockTemplateView::event(QEvent *event) {
}
/**
Given a cells list, change their position so the top left one is at row \a x and column \a y.
@brief TitleBlockTemplateView::normalizeCells
Given a cells list,
change their position so the top left one is at row \a x and column \a y.
@param cells Cells list
@param x : row
@param y : column
*/
void TitleBlockTemplateView::normalizeCells(QList<TitleBlockCell> &cells, int x, int y) const {
if (!cells.count()) return;
@@ -1051,7 +1060,8 @@ void TitleBlockTemplateView::removeItem(QGraphicsLayoutItem *item) {
}
/**
@param a list of QGraphicsItem
@brief TitleBlockTemplateView::makeCellsSetFromGraphicsItems
@param items : a list of QGraphicsItem
@return the corresponding TitleBlockTemplateCellsSet
*/
TitleBlockTemplateCellsSet TitleBlockTemplateView::makeCellsSetFromGraphicsItems(const QList<QGraphicsItem *> &items) const {
@@ -1066,8 +1076,9 @@ TitleBlockTemplateCellsSet TitleBlockTemplateView::makeCellsSetFromGraphicsItems
return(set);
}
/*
@param a text string
/**
@brief TitleBlockTemplateView::makePrettyToolTip
@param string : a text string
@return an HTML string that can be passed to setToolTip()
*/
QString TitleBlockTemplateView::makePrettyToolTip(const QString &string) {