From: Agnelo Vaz <agnelo.vaz@samsung.com>
Date: Mon, 22 Oct 2018 14:38:12 +0000 (+0100)
Subject: Update to doxygen for SetLayoutParametersUsingResizePolicy API
X-Git-Tag: dali_1.3.47~4^2
X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=b02f3f750ac8d0633a854783dc5c3d88cc2da4b5;hp=71edd1925f5012bcbeb7a3c969372d36e5ca6227;ds=inline

Update to doxygen for SetLayoutParametersUsingResizePolicy API

Change-Id: I98cfa2c37417bc33a8b10bc7fb895b77e12510f1
---

diff --git a/dali-toolkit/internal/layouting/size-negotiation-mapper.h b/dali-toolkit/internal/layouting/size-negotiation-mapper.h
index d89996c..082da33 100644
--- a/dali-toolkit/internal/layouting/size-negotiation-mapper.h
+++ b/dali-toolkit/internal/layouting/size-negotiation-mapper.h
@@ -40,17 +40,19 @@ namespace SizeNegotiationMapper
  * @param[out] control the control to set the layout params on
  * @param[out] layout the layout for the given control
  * @param[in] dimension the dimension or dimensions the resize policy applies to.
+ * @note If Dimension::ALL_DIMENSIONS is provided as the dimension parameter then Dimension::WIDTH is used for
+ *       both height and width mapping.
  */
 void SetLayoutParametersUsingResizePolicy( Toolkit::Control control, Toolkit::Internal::LayoutItemPtr layout, const Dimension::Type dimension );
 
 /**
  * @brief Sets the child layout parameters on the control using the a ResizePolicy that is dependant on it's parent
- * @note This method should be used after a child has been parented and a parent measure spec is available.
  * @param[out] control the control to set the layout params on
  * @param[in] parentWidthSpecification the parent's width measure specification
  * @param[in] parentHeightSpecification the parent's height measure specification
  * @param[out] childWidth the resulting child width
  * @param[out] childHeight the resulting child height
+ * @note This method should be used after a child has been parented and a parent measure spec is available.
  */
 void GetSizeofChildForParentDependentResizePolicy( Toolkit::Control control, const MeasureSpec parentWidthSpecification, const MeasureSpec parentHeightSpecification, LayoutLength& childWidth, LayoutLength& childHeight );