Merge branch 'dev' into wip/animationwip/animation

Change-Id: I6e770609c90a7745d08fa4e2f424e865678c5d6f

1 files changed, 16 insertions, 28 deletions

diff --git a/src/render/texture/qpaintedtextureimage.cpp b/src/render/texture/qpaintedtextureimage.cpp
index 9ae43378a..4d03eb809 100644
--- a/src/render/texture/qpaintedtextureimage.cpp
+++ b/src/render/texture/qpaintedtextureimage.cpp
@@ -104,14 +104,9 @@ QPaintedTextureImage::~QPaintedTextureImage()
 /*!
     \property QPaintedTextureImage::width
 
-    Holds the width of the texture image
- */
-
-/*!
-    \property QPaintedTextureImage::width
-
-    \return the width of the texture image.
- */
+    This property holds the width of the texture image.
+    The width must be greater than or equal to 1.
+*/
 int QPaintedTextureImage::width() const
 {
     Q_D(const QPaintedTextureImage);
@@ -121,14 +116,9 @@ int QPaintedTextureImage::width() const
 /*!
     \property QPaintedTextureImage::height
 
-    Holds the height of the texture image
- */
-
-/*!
-    \property QPaintedTextureImage::height
-
-    \return the height of the texture image.
- */
+    This property holds the height of the texture image.
+    The height must be greater than or equal to 1.
+*/
 int QPaintedTextureImage::height() const
 {
     Q_D(const QPaintedTextureImage);
@@ -138,14 +128,11 @@ int QPaintedTextureImage::height() const
 /*!
     \property QPaintedTextureImage::size
 
-    Holds the width and height of the texture image
- */
+    This property holds the size of the texture image.
 
-/*!
-    \property QPaintedTextureImage::size
+    \sa height, width
 
-    \return the size of the texture image.
- */
+*/
 QSize QPaintedTextureImage::size() const
 {
     Q_D(const QPaintedTextureImage);
@@ -153,7 +140,7 @@ QSize QPaintedTextureImage::size() const
 }
 
 /*!
-    Sets the width of the texture image. Triggers an update, if the size changes.
+    Sets the width (\a w) of the texture image. Triggers an update, if the size changes.
  */
 void QPaintedTextureImage::setWidth(int w)
 {
@@ -165,7 +152,7 @@ void QPaintedTextureImage::setWidth(int w)
 }
 
 /*!
-    Sets the height of the texture image. Triggers an update, if the size changes.
+    Sets the height (\a h) of the texture image. Triggers an update, if the size changes.
  */
 void QPaintedTextureImage::setHeight(int h)
 {
@@ -177,7 +164,7 @@ void QPaintedTextureImage::setHeight(int h)
 }
 
 /*!
-    Sets the width and height of the texture image. Triggers an update, if the size changes.
+    Sets the width and height of the texture image. Triggers an update, if the \a size changes.
  */
 void QPaintedTextureImage::setSize(QSize size)
 {
@@ -206,9 +193,10 @@ void QPaintedTextureImage::setSize(QSize size)
 }
 
 /*!
-    Will trigger an update of the texture image, meaning the paint() method will
-    be invoked.
- */
+   Schedules the painted texture's paint() function to be called,
+   which in turn uploads the new image to the GPU.
+   Parameter \a rect is currently unused.
+*/
 void QPaintedTextureImage::update(const QRect &rect)
 {
     Q_UNUSED(rect)