From: Adeel Kazmi Date: Wed, 27 Apr 2016 15:38:28 +0000 (-0700) Subject: Merge "Fix doxygen errors and enable doxygen build for devel-api" into devel/master X-Git-Tag: dali_1.1.32~7 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=8a28af5eb9edebeb36a7748420c560289930adef;hp=15b2575b05e4eb25c12f398d5a426fc021736df9 Merge "Fix doxygen errors and enable doxygen build for devel-api" into devel/master --- diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index 72ed846..b14f125 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -891,9 +891,11 @@ WARN_LOGFILE = INPUT = @DOXYGEN_DOCS_DIR@/content \ @prefix@/include/dali/doc/dali-core-doc.h \ @prefix@/include/dali/doc/dali-adaptor-doc.h \ - ../../../../dali-toolkit/doc/dali-toolkit-doc.h \ + ../../../doc/dali-toolkit-doc.h \ @prefix@/include/dali/public-api \ - ../../../../dali-toolkit/dali-toolkit/public-api \ + @prefix@/include/dali/devel-api \ + ../../../dali-toolkit/public-api \ + ../../../dali-toolkit/devel-api \ ../../../automated-tests/README.md # This tag can be used to specify the character encoding of the source files diff --git a/dali-toolkit/devel-api/controls/flex-container/flex-container.h b/dali-toolkit/devel-api/controls/flex-container/flex-container.h index b8540e9..97a9bdb 100644 --- a/dali-toolkit/devel-api/controls/flex-container/flex-container.h +++ b/dali-toolkit/devel-api/controls/flex-container/flex-container.h @@ -53,12 +53,13 @@ class FlexContainer; * Below is an illustration of the various directions and terms as applied to a flex * container with the "flex direction" defined as "row". * + * @code * flex container * --------------------------------------------------------------- cross start * | ------------------ --------|--------------------------- | * | | | | | | | * | | | | | | | - * | | flex item 1 | | | flex item 2 | | main axis + * | | flex item 1 | | | flex item 2 | | main axis * |-|----------------|-|-------|--------------------------|-|------------> * | | | | | | | * | | | | | | | @@ -69,6 +70,7 @@ class FlexContainer; * | main start | cross axis | main end * | | | * v + * @endcode * * @nosubgrouping *

Per-child Custom properties for script supporting:

diff --git a/dali-toolkit/devel-api/controls/popup/popup.h b/dali-toolkit/devel-api/controls/popup/popup.h index b0bf93d..6251c01 100644 --- a/dali-toolkit/devel-api/controls/popup/popup.h +++ b/dali-toolkit/devel-api/controls/popup/popup.h @@ -215,7 +215,7 @@ public: /** * @brief Sets the actor to use for a footer in this Popup. * - * @param[in] control The footer actor to be added to this Popup + * @param[in] footer The footer actor to be added to this Popup */ void SetFooter( Actor footer ); diff --git a/dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h b/dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h index be5db96..fe31a7e 100644 --- a/dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h +++ b/dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h @@ -99,7 +99,7 @@ public: * Depth-index controls draw-order for overlapping renderers. * Renderer with higher depth indices are rendered in front of other renderer with smaller values * - * @param[in] depthIndex The depth index of this renderer. + * @param[in] index The depth index of this renderer. */ void SetDepthIndex( float index ); diff --git a/dali-toolkit/devel-api/image-atlas/image-atlas.h b/dali-toolkit/devel-api/image-atlas/image-atlas.h index 315584a..395615d 100644 --- a/dali-toolkit/devel-api/image-atlas/image-atlas.h +++ b/dali-toolkit/devel-api/image-atlas/image-atlas.h @@ -83,7 +83,7 @@ public: /** * @brief This assignment operator is required for (smart) pointer semantics. * - * @param [in] rhs A reference to the copied handle + * @param [in] handle A reference to the copied handle * @return A reference to this */ ImageAtlas& operator=( const ImageAtlas& handle ); diff --git a/dali-toolkit/devel-api/shader-effects/dissolve-effect.h b/dali-toolkit/devel-api/shader-effects/dissolve-effect.h index 0825a5d..5c929b9 100644 --- a/dali-toolkit/devel-api/shader-effects/dissolve-effect.h +++ b/dali-toolkit/devel-api/shader-effects/dissolve-effect.h @@ -35,9 +35,10 @@ namespace Toolkit * As we use the texture coordinate as pixel position to calculate random offset, * the line should passing through rectangle {(0,0),(0,1),(1,0),(1,1)}, * so make the position parameter with two component values between 0.0 to 1.0 + * @param[in] actor The actor that registers the uniform properties * @param[in] position The point ( locates within rectangle {(0,0),(0,1),(1,0),(1,1)} ) passed through by the central line * @param[in] displacement The direction of the central line - * @param[in] initialProgress, the normalised initial progress of the shader + * @param[in] initialProgress The normalised initial progress of the shader */ inline void DissolveEffectSetCentralLine( Actor& actor, const Vector2& position, const Vector2& displacement, float initialProgress ) { diff --git a/dali-toolkit/devel-api/shader-effects/motion-blur-effect.h b/dali-toolkit/devel-api/shader-effects/motion-blur-effect.h index 310e3ce..8e71791 100644 --- a/dali-toolkit/devel-api/shader-effects/motion-blur-effect.h +++ b/dali-toolkit/devel-api/shader-effects/motion-blur-effect.h @@ -30,7 +30,8 @@ namespace Toolkit /** * @brief Set the properties for the motion blur * - * @param numBlurSamples Number of samples used by the shader + * @param[in] actor The actor that registers the uniform properties + * @param[in] numBlurSamples Number of samples used by the shader */ inline void SetMotionBlurProperties( Actor& actor, unsigned int numBlurSamples = 8 ) { diff --git a/dali-toolkit/internal/controls/flex-container/flex-container-impl.h b/dali-toolkit/internal/controls/flex-container/flex-container-impl.h index 58c25b6..17ea2b6 100644 --- a/dali-toolkit/internal/controls/flex-container/flex-container-impl.h +++ b/dali-toolkit/internal/controls/flex-container/flex-container-impl.h @@ -250,20 +250,20 @@ private: // Data // Helpers for public-api forwarding methods -inline Toolkit::Internal::FlexContainer& GetImpl( Toolkit::FlexContainer& tableView ) +inline Toolkit::Internal::FlexContainer& GetImpl( Toolkit::FlexContainer& flexContainer ) { - DALI_ASSERT_ALWAYS(tableView); + DALI_ASSERT_ALWAYS(flexContainer); - Dali::RefObject& handle = tableView.GetImplementation(); + Dali::RefObject& handle = flexContainer.GetImplementation(); return static_cast(handle); } -inline const Toolkit::Internal::FlexContainer& GetImpl( const Toolkit::FlexContainer& tableView ) +inline const Toolkit::Internal::FlexContainer& GetImpl( const Toolkit::FlexContainer& flexContainer ) { - DALI_ASSERT_ALWAYS(tableView); + DALI_ASSERT_ALWAYS(flexContainer); - const Dali::RefObject& handle = tableView.GetImplementation(); + const Dali::RefObject& handle = flexContainer.GetImplementation(); return static_cast(handle); } diff --git a/doc/dali-toolkit-doc.h b/doc/dali-toolkit-doc.h index 784cb4d..d390f9a 100644 --- a/doc/dali-toolkit-doc.h +++ b/doc/dali-toolkit-doc.h @@ -156,6 +156,9 @@ * @defgroup dali_toolkit_controls_text_controls Text Controls * @brief Controls for displaying text or text input. + * @defgroup dali_toolkit_controls_flex_container Flex Container + * @brief FlexContainer is a container for Flexbox layout. + * @} * @defgroup dali_toolkit_managers Managers