From 105cff0f63ff6dd80b8a7d5823652be2c2677dff Mon Sep 17 00:00:00 2001
From: Conrad <grosserconrad@gmail.com>
Date: Thu, 19 Dec 2019 17:41:31 +0100
Subject: [PATCH] Added basic documentation for LayerObject Struct

---
 src/Layer/PaintingArea.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/Layer/PaintingArea.h b/src/Layer/PaintingArea.h
index 7e61e04..743dbc1 100644
--- a/src/Layer/PaintingArea.h
+++ b/src/Layer/PaintingArea.h
@@ -13,6 +13,14 @@
 #include "Tool/IntelliTool.h"
 #include "IntelliHelper/IntelliColorPicker.h"
 
+/*!
+ * \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{
     IntelliImage* image;
     int width;