diff --git a/src/Image/IntelliImage.h b/src/Image/IntelliImage.h index 0d2fe42..116a01d 100644 --- a/src/Image/IntelliImage.h +++ b/src/Image/IntelliImage.h @@ -69,7 +69,7 @@ virtual ~IntelliImage() = 0; virtual void drawPixel(const QPoint &p1, const QColor& color); /*! - * \brief A function that draws A Line between two given Points in a given color. + * \brief A function that draws a line between two given points in a given color. * \param p1 - The coordinates of the first Point. * \param p2 - The coordinates of the second Point. * \param color - The color of the line. @@ -78,10 +78,10 @@ virtual void drawPixel(const QPoint &p1, const QColor& color); virtual void drawLine(const QPoint &p1, const QPoint& p2, const QColor& color, const int& penWidth); /*! - * \brief A - * \param p1 - * \param color - * \param penWidth + * \brief A function that draws a point between on a given point in a given color. + * \param p1 - The coordinates of the first Point. + * \param color - The color of the point. + * \param penWidth - The size of the point. */ virtual void drawPoint(const QPoint &p1, const QColor& color, const int& penWidth); diff --git a/src/Layer/PaintingArea.h b/src/Layer/PaintingArea.h index c282c39..066450c 100644 --- a/src/Layer/PaintingArea.h +++ b/src/Layer/PaintingArea.h @@ -16,18 +16,31 @@ /*! * \brief The LayerObject struct holds all the information needed to construct a layer - * \param width - Stores the width of a layer in pixels - * \param height - Stores the height of a layer in pixels - * \param alpha - Stores the alpha value of the layer (default=255) - * \param widthOffset - Stores the number of pixles from the left side of the painting area - * \param heightOffset - Stores the number of pixles from the top of the painting area */ struct LayerObject { + /*! + * \brief image - Stores the imageData of the current LayerObject. + */ IntelliImage* image; + /*! + * \brief width - Stores the width of a layer in pixels. + */ int width; + /*! + * \brief height - Stores the height of a layer in pixels. + */ int height; + /*! + * \brief widthOffset - Stores the number of pixles from the left side of the painting area. + */ int widthOffset; + /*! + * \brief heightOffset - Stores the number of pixles from the top of the painting area. + */ int heightOffset; + /*! + * \brief alpha - Stores the alpha value of the layer (default=255). + */ int alpha = 255; }; @@ -60,15 +73,15 @@ PaintingArea(int maxWidth = 600, int maxHeight = 600, QWidget*parent = nullptr); void setRenderSettings(bool isFastRenderingOn); /*! - * \brief The open method is used for loading a picture into the current layer - * \param fileName - Path and filename which are used to determine where the to-be-opened file is stored - * \return Returns a boolean variable whether the file was successfully opened or not + * \brief The open method is used for loading a picture into the current layer. + * \param filePath - Path and Name which are used to determine where the to-be-opened file is stored. + * \return Returns a boolean variable whether the file was successfully opened or not. */ bool open(const QString &filePath); /*! * \brief The save method is used for exporting the current project as one picture - * \param fileName - * \param fileFormat + * \param filePath - Specifies the path and name of the file to create. + * \param fileFormat - Specifies the format of the file to create. * \return Returns a boolean variable, true if the file was saved successfully, false if not */ bool save(const QString &filePath, const char*fileFormat);