Filling more gaps in the documentation.
This commit is contained in:
parent
4525662fae
commit
9daeae12fe
|
@ -101,7 +101,7 @@ private slots:
|
|||
|
||||
/**
|
||||
* @brief on_ActivePieceListChanged Called when the active piece list is changed
|
||||
* @param index
|
||||
* @param index piece index
|
||||
*/
|
||||
void on_ActivePieceListChanged(int index);
|
||||
};
|
||||
|
|
|
@ -60,7 +60,7 @@ public:
|
|||
|
||||
/**
|
||||
* @brief SetCarrousel Sets the carrousel corresponding to the list
|
||||
* @param carrousel
|
||||
* @param carrousel pointer to the carrousel
|
||||
*/
|
||||
void SetCarrousel(VPCarrousel *carrousel);
|
||||
|
||||
|
|
|
@ -222,7 +222,7 @@ private:
|
|||
|
||||
/**
|
||||
* @brief generateTiledPdf Generates the tiled Pdf in the given filename
|
||||
* @param filename
|
||||
* @param filename output file name
|
||||
*/
|
||||
void generateTiledPdf(QString fileName);
|
||||
|
||||
|
@ -288,7 +288,7 @@ private slots:
|
|||
/**
|
||||
* @brief on_lineEditSheetName_textChanged When the name of the sheet is changed
|
||||
* in the sheet layout tab
|
||||
* @param text
|
||||
* @param text name of the sheet
|
||||
*/
|
||||
void on_lineEditSheetName_textChanged(const QString &text);
|
||||
|
||||
|
@ -329,7 +329,7 @@ private slots:
|
|||
/**
|
||||
* @brief on_checkBoxSheetShowGrid_toggled When the checkbox "show grid" is
|
||||
* clicked
|
||||
* @param checked
|
||||
* @param checked show grid
|
||||
*/
|
||||
void on_checkBoxSheetShowGrid_toggled(bool checked);
|
||||
|
||||
|
@ -393,7 +393,7 @@ private slots:
|
|||
/**
|
||||
* @brief on_checkBoxTilesShowTiles_toggled When the checkbox "show tiles" is
|
||||
* clicked
|
||||
* @param checked
|
||||
* @param checked show tiles
|
||||
*/
|
||||
void on_checkBoxTilesShowTiles_toggled(bool checked);
|
||||
|
||||
|
|
|
@ -105,8 +105,8 @@ public:
|
|||
* @brief RotateToGrainline rotates the piece, so that the grainline has
|
||||
* the given angle
|
||||
*
|
||||
* @param angleOfGrainline
|
||||
* @param add180IfAlreadyInPosition, automatically adds 180, if the piece is
|
||||
* @param angleOfGrainline angle of grainline
|
||||
* @param add180IfAlreadyInPosition automatically adds 180, if the piece is
|
||||
* already in the grainline position
|
||||
*/
|
||||
void RotateToGrainline(qreal angleOfGrainline, bool add180IfAlreadyInPosition = false);
|
||||
|
@ -132,7 +132,7 @@ public:
|
|||
|
||||
/**
|
||||
* @brief SetPieceList Sets the pieceList of the piece to the given pieceList
|
||||
* @param pieceList
|
||||
* @param pieceList pointer to the piece list
|
||||
*/
|
||||
void SetPieceList(VPPieceList* pieceList);
|
||||
|
||||
|
|
|
@ -78,14 +78,14 @@ public:
|
|||
|
||||
/**
|
||||
* @brief GetTemplateSize Returns the size in Px of the given template
|
||||
* @param tmpl
|
||||
* @param tmpl paper size template
|
||||
* @return the size in Px
|
||||
*/
|
||||
static QSizeF GetTemplateSize(PaperSizeTemplate tmpl);
|
||||
|
||||
/**
|
||||
* @brief GetTemplateName Returns the name of the given template
|
||||
* @param tmpl
|
||||
* @param tmpl paper size template
|
||||
* @return name of the given template
|
||||
*/
|
||||
static QString GetTemplateName(PaperSizeTemplate tmpl);
|
||||
|
@ -99,14 +99,14 @@ public:
|
|||
|
||||
/**
|
||||
* @brief PopulateComboBox Populates the given combo with the given templates
|
||||
* @param tmpls
|
||||
* @param comboBox
|
||||
* @param tmpls list of paper size templates
|
||||
* @param comboBox pointer to the combobox
|
||||
*/
|
||||
static void PopulateComboBox(QVector<PaperSizeTemplate> *tmpls, QComboBox* comboBox);
|
||||
|
||||
/**
|
||||
* @brief isRollTemplate Returns wether the given template is a roll or not.
|
||||
* @param tmpl
|
||||
* @param tmpl paper size template
|
||||
* @return true if the given template is a roll
|
||||
*/
|
||||
static bool isRollTemplate(PaperSizeTemplate tmpl);
|
||||
|
@ -270,7 +270,7 @@ public:
|
|||
|
||||
/**
|
||||
* @brief GetShowGrid Returns true if the placement grid has to be shown on the current sheet
|
||||
* @return
|
||||
* @return true if the placement grid has to be shown on the current sheet
|
||||
*/
|
||||
bool GetShowGrid();
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user