(toolkit) fix klocwork issues

[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / relayout-helper.h

diff --git a/base/dali-toolkit/internal/controls/relayout-helper.h b/base/dali-toolkit/internal/controls/relayout-helper.h
index b356262..c7f2372 100644 (file)
--- a/base/dali-toolkit/internal/controls/relayout-helper.h
+++ b/base/dali-toolkit/internal/controls/relayout-helper.h
@@ -18,9 +18,9 @@
  *
  */
 
-// INTERNAL INCLUDES
-#include <dali/dali.h>
-
+// EXTERNAL INCLUDES
+#include <dali/public-api/actors/actor.h>
+#include <dali/public-api/math/vector3.h>
 
 namespace Dali
 {
@@ -35,12 +35,30 @@ namespace RelayoutHelper
 {
 
 /**
+ * Gets the natural size of the given actor.
+ *
+ * If the actor is a Control, it returns the natural size of the Control. @see Control::GetNaturalSize()
+ * If the actor is an ImageActor, it returns the size of the image.
+ * If the actor is a TextActor, it returns the size of the text. @see Font::MeasureText()
+ * Otherwise it returns the actor's current size. @see Actor::GetCurrentSize()
+ *
+ * @param[in] actor The actor.
  *
+ * @return The natural size.
  */
 Vector3 GetNaturalSize( Actor actor );
 
 /**
+ * Gets the actor's height for the given width.
+ *
+ * If the actor is a Control it returns the height for width. @see Control::GetHeightForWidth()
+ * If the actor is an ImageActor or a TextActor it scales the natural size to fit the given width. @see GetNaturalSize()
+ * Otherwise it returns the actor's current size. @see Actor::GetCurrentSize()
+ *
+ * @param[in] actor The actor.
+ * @param[in] width The width.
  *
+ * @return The actor's height for given width.
  */
 float GetHeightForWidth( Actor actor, float width );