From 4525662fae972af2ac3f16f11788b2886403e1d9 Mon Sep 17 00:00:00 2001
From: Roman Telezhynskyi <dismine@gmail.com>
Date: Mon, 26 Apr 2021 09:14:48 +0300
Subject: [PATCH] Complete code documentation to satisfy Clang.

---
 src/app/puzzle/vplayout.h           |  6 +++---
 src/app/puzzle/vpmaingraphicsview.h |  2 +-
 src/app/puzzle/vppiece.h            |  2 +-
 src/app/puzzle/vpsheet.h            |  8 ++++----
 src/app/puzzle/vptilefactory.h      | 14 +++++++-------
 5 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/src/app/puzzle/vplayout.h b/src/app/puzzle/vplayout.h
index f8ff3a7ee..fa742434d 100644
--- a/src/app/puzzle/vplayout.h
+++ b/src/app/puzzle/vplayout.h
@@ -92,7 +92,7 @@ public:
 
     /**
      * @brief GetTitle Returns the title of the layout
-     * @return
+     * @return title of the layout
      */
     QString GetTitle() const;
 
@@ -104,7 +104,7 @@ public:
 
     /**
      * @brief GetDescription Returns the description of the layout.
-     * @return
+     * @return description of the layout
      */
     QString GetDescription() const;
 
@@ -250,7 +250,7 @@ public:
 
     /**
      * @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();
 
diff --git a/src/app/puzzle/vpmaingraphicsview.h b/src/app/puzzle/vpmaingraphicsview.h
index f1cef49b0..42e774df4 100644
--- a/src/app/puzzle/vpmaingraphicsview.h
+++ b/src/app/puzzle/vpmaingraphicsview.h
@@ -54,7 +54,7 @@ public:
 
     /**
      * @brief GetScene Returns the scene of the view
-     * @return
+     * @return scene of the view
      */
     VMainGraphicsScene* GetScene();
 
diff --git a/src/app/puzzle/vppiece.h b/src/app/puzzle/vppiece.h
index f14148f18..b48964315 100644
--- a/src/app/puzzle/vppiece.h
+++ b/src/app/puzzle/vppiece.h
@@ -61,7 +61,7 @@ public:
 
     /**
      * @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;
 
diff --git a/src/app/puzzle/vpsheet.h b/src/app/puzzle/vpsheet.h
index f1423dcab..dea6ab423 100644
--- a/src/app/puzzle/vpsheet.h
+++ b/src/app/puzzle/vpsheet.h
@@ -86,14 +86,14 @@ public:
     /**
      * @brief GetTemplateName Returns the name of the given template
      * @param tmpl
-     * @return
+     * @return name of the given template
      */
     static QString GetTemplateName(PaperSizeTemplate tmpl);
 
     /**
      * @brief GetTemplate GetTemplate Returns the template that corresponds to the given size
      * @param size the Size in Px
-     * @return
+     * @return template that corresponds to the given size
      */
     static PaperSizeTemplate GetTemplate(QSizeF size);
 
@@ -107,13 +107,13 @@ public:
     /**
      * @brief isRollTemplate Returns wether the given template is a roll or not.
      * @param tmpl
-     * @return
+     * @return true if the given template is a roll
      */
     static bool isRollTemplate(PaperSizeTemplate tmpl);
 
     /**
      * @brief GetLayout Returns the Layout of the sheet
-     * @return
+     * @return Layout of the sheet
      */
     VPLayout* GetLayout();
 
diff --git a/src/app/puzzle/vptilefactory.h b/src/app/puzzle/vptilefactory.h
index 5f363b656..839ee0c06 100644
--- a/src/app/puzzle/vptilefactory.h
+++ b/src/app/puzzle/vptilefactory.h
@@ -50,9 +50,9 @@ public:
     /**
      * @brief drawTile draws the tile of given coordinate (row, col) from the
      * current sheet of the layout with the given painter
-     * @param painter
-     * @param row
-     * @param col
+     * @param painter pointer to painter
+     * @param row current row
+     * @param col current column
      */
     void drawTile(QPainter *painter, VPMainGraphicsView *graphicsView, int row, int col);
 
@@ -63,25 +63,25 @@ public:
 
     /**
      * @brief getRowNb Returns the number of row pages
-     * @return
+     * @return number of row pages
      */
     int getRowNb();
 
     /**
      * @brief getColNb Returns the number of col pages
-     * @return
+     * @return number of col pages
      */
     int getColNb();
 
     /**
      * @brief getDrawingAreaHeight Returns the usable height of the tile in Px
-     * @return
+     * @return usable height of the tile in Px
      */
     qreal getDrawingAreaHeight();
 
     /**
      * @brief getDrawingAreaWidth Returns the usable width of the tile in Px
-     * @return
+     * @return usable width of the tile in Px
      */
     qreal getDrawingAreaWidth();