Complete code documentation to satisfy Clang.

This commit is contained in:
Roman Telezhynskyi 2021-04-26 09:14:48 +03:00
parent c0afa2408e
commit 4525662fae
5 changed files with 16 additions and 16 deletions

View File

@ -92,7 +92,7 @@ public:
/** /**
* @brief GetTitle Returns the title of the layout * @brief GetTitle Returns the title of the layout
* @return * @return title of the layout
*/ */
QString GetTitle() const; QString GetTitle() const;
@ -104,7 +104,7 @@ public:
/** /**
* @brief GetDescription Returns the description of the layout. * @brief GetDescription Returns the description of the layout.
* @return * @return description of the layout
*/ */
QString GetDescription() const; QString GetDescription() const;
@ -250,7 +250,7 @@ public:
/** /**
* @brief GetShowTiles Returns true if the tiles has to be shown on the current sheet * @brief GetShowTiles Returns true if the tiles has to be shown on the current sheet
* @return * @return true if the tiles has to be shown on the current sheet
*/ */
bool GetShowTiles(); bool GetShowTiles();

View File

@ -54,7 +54,7 @@ public:
/** /**
* @brief GetScene Returns the scene of the view * @brief GetScene Returns the scene of the view
* @return * @return scene of the view
*/ */
VMainGraphicsScene* GetScene(); VMainGraphicsScene* GetScene();

View File

@ -61,7 +61,7 @@ public:
/** /**
* @brief GetMirrorPiece returns wether the piece is mirrored or not * @brief GetMirrorPiece returns wether the piece is mirrored or not
* @return true if the piece is mirrored * @return true if the piece is mirrored
*/ */
bool GetPieceMirrored() const; bool GetPieceMirrored() const;

View File

@ -86,14 +86,14 @@ public:
/** /**
* @brief GetTemplateName Returns the name of the given template * @brief GetTemplateName Returns the name of the given template
* @param tmpl * @param tmpl
* @return * @return name of the given template
*/ */
static QString GetTemplateName(PaperSizeTemplate tmpl); static QString GetTemplateName(PaperSizeTemplate tmpl);
/** /**
* @brief GetTemplate GetTemplate Returns the template that corresponds to the given size * @brief GetTemplate GetTemplate Returns the template that corresponds to the given size
* @param size the Size in Px * @param size the Size in Px
* @return * @return template that corresponds to the given size
*/ */
static PaperSizeTemplate GetTemplate(QSizeF size); static PaperSizeTemplate GetTemplate(QSizeF size);
@ -107,13 +107,13 @@ public:
/** /**
* @brief isRollTemplate Returns wether the given template is a roll or not. * @brief isRollTemplate Returns wether the given template is a roll or not.
* @param tmpl * @param tmpl
* @return * @return true if the given template is a roll
*/ */
static bool isRollTemplate(PaperSizeTemplate tmpl); static bool isRollTemplate(PaperSizeTemplate tmpl);
/** /**
* @brief GetLayout Returns the Layout of the sheet * @brief GetLayout Returns the Layout of the sheet
* @return * @return Layout of the sheet
*/ */
VPLayout* GetLayout(); VPLayout* GetLayout();

View File

@ -50,9 +50,9 @@ public:
/** /**
* @brief drawTile draws the tile of given coordinate (row, col) from the * @brief drawTile draws the tile of given coordinate (row, col) from the
* current sheet of the layout with the given painter * current sheet of the layout with the given painter
* @param painter * @param painter pointer to painter
* @param row * @param row current row
* @param col * @param col current column
*/ */
void drawTile(QPainter *painter, VPMainGraphicsView *graphicsView, int row, int col); void drawTile(QPainter *painter, VPMainGraphicsView *graphicsView, int row, int col);
@ -63,25 +63,25 @@ public:
/** /**
* @brief getRowNb Returns the number of row pages * @brief getRowNb Returns the number of row pages
* @return * @return number of row pages
*/ */
int getRowNb(); int getRowNb();
/** /**
* @brief getColNb Returns the number of col pages * @brief getColNb Returns the number of col pages
* @return * @return number of col pages
*/ */
int getColNb(); int getColNb();
/** /**
* @brief getDrawingAreaHeight Returns the usable height of the tile in Px * @brief getDrawingAreaHeight Returns the usable height of the tile in Px
* @return * @return usable height of the tile in Px
*/ */
qreal getDrawingAreaHeight(); qreal getDrawingAreaHeight();
/** /**
* @brief getDrawingAreaWidth Returns the usable width of the tile in Px * @brief getDrawingAreaWidth Returns the usable width of the tile in Px
* @return * @return usable width of the tile in Px
*/ */
qreal getDrawingAreaWidth(); qreal getDrawingAreaWidth();