From: Seoyeon Kim Date: Fri, 24 Jun 2016 07:14:59 +0000 (+0900) Subject: Exclude internal tag module in Public API reference X-Git-Tag: dali_1.2.1~6^2 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=315b80da193f3ce70ffc07d3502af970ed1146b5 Exclude internal tag module in Public API reference Change-Id: I3fc95f79fd6adbc98c60d3fd3a790fda29bc3a9e Signed-off-by: Seoyeon Kim --- diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index 3653af7..791c8dd 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -918,38 +918,9 @@ INPUT_ENCODING = UTF-8 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ +FILE_PATTERNS = \ *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.vhd \ - *.vhdl + *.md # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. diff --git a/dali-toolkit/public-api/controls/alignment/alignment.h b/dali-toolkit/public-api/controls/alignment/alignment.h index a5360d7..b290856 100644 --- a/dali-toolkit/public-api/controls/alignment/alignment.h +++ b/dali-toolkit/public-api/controls/alignment/alignment.h @@ -236,6 +236,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -251,6 +252,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL Alignment( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index 8893d88..cd142c5 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -520,6 +520,7 @@ public: //Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -535,6 +536,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL Button( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/buttons/check-box-button.h b/dali-toolkit/public-api/controls/buttons/check-box-button.h index fb8e5e8..91f0157 100644 --- a/dali-toolkit/public-api/controls/buttons/check-box-button.h +++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h @@ -105,6 +105,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -118,6 +119,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 0b03907..4beab96 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -219,6 +219,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -234,6 +235,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h index 110a6a6..3dcd111 100644 --- a/dali-toolkit/public-api/controls/buttons/radio-button.h +++ b/dali-toolkit/public-api/controls/buttons/radio-button.h @@ -147,6 +147,7 @@ class DALI_IMPORT_API RadioButton: public Button public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -162,6 +163,7 @@ class DALI_IMPORT_API RadioButton: public Button * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 8b24a6f..7cd1dcd 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -251,6 +251,7 @@ public: */ bool IsKeyboardFocusGroup(); + /// @cond internal /** * @brief Called by the AccessibilityManager to activate the Control. * @SINCE_1_0.0 @@ -262,6 +263,7 @@ public: * @SINCE_1_0.0 */ DALI_INTERNAL void KeyboardEnter(); + /// @endcond // Signals @@ -280,6 +282,7 @@ public: */ Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); + /// @cond internal /** * @brief Called by the KeyInputFocusManager to emit key event signals. * @@ -288,6 +291,7 @@ public: * @return True if the event was consumed. */ DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); + /// @endcond protected: // For derived classes to call @@ -685,12 +689,14 @@ public: // API for derived classes to override private: + /// @cond internal // Undefined DALI_INTERNAL Control( const Control& ); DALI_INTERNAL Control& operator=( const Control& ); class Impl; Impl* mImpl; + /// @endcond }; diff --git a/dali-toolkit/public-api/controls/flex-container/flex-container.h b/dali-toolkit/public-api/controls/flex-container/flex-container.h index 856c83a..d3cd972 100644 --- a/dali-toolkit/public-api/controls/flex-container/flex-container.h +++ b/dali-toolkit/public-api/controls/flex-container/flex-container.h @@ -271,6 +271,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_1.35 @@ -286,6 +287,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL FlexContainer( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h index 524943d..5364217 100644 --- a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h +++ b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h @@ -298,6 +298,7 @@ public: // Signals public: + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -311,6 +312,7 @@ public: * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL GaussianBlurView( Dali::Internal::CustomActor* internal ); + /// @endcond }; diff --git a/dali-toolkit/public-api/controls/image-view/image-view.h b/dali-toolkit/public-api/controls/image-view/image-view.h index bc401f1..51489c9 100644 --- a/dali-toolkit/public-api/controls/image-view/image-view.h +++ b/dali-toolkit/public-api/controls/image-view/image-view.h @@ -242,6 +242,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -257,6 +258,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal ); + /// @endcond }; diff --git a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h index 85b8aa8..97932f9 100644 --- a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h +++ b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h @@ -143,6 +143,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -158,6 +159,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL Model3dView( Dali::Internal::CustomActor* internal ); + /// @endcond }; diff --git a/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h b/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h index da8a4cd..d8503bf 100644 --- a/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h +++ b/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h @@ -87,6 +87,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -100,6 +101,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL PageTurnLandscapeView( Dali::Internal::CustomActor* internal ); + /// @endcond }; } // namespace Toolkit diff --git a/dali-toolkit/public-api/controls/page-turn-view/page-turn-portrait-view.h b/dali-toolkit/public-api/controls/page-turn-view/page-turn-portrait-view.h index deab41e..7a95bc0 100644 --- a/dali-toolkit/public-api/controls/page-turn-view/page-turn-portrait-view.h +++ b/dali-toolkit/public-api/controls/page-turn-view/page-turn-portrait-view.h @@ -88,6 +88,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_1.4 @@ -101,6 +102,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL PageTurnPortraitView( Dali::Internal::CustomActor* internal ); + /// @endcond }; } // namespace Toolkit diff --git a/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h b/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h index 42c8b48..ef4821b 100644 --- a/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h +++ b/dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h @@ -182,6 +182,7 @@ public: //Signal public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_1.4 @@ -195,6 +196,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL PageTurnView(Dali::Internal::CustomActor* internal); + /// @endcond }; } // namespace Toolkit diff --git a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h index f8cbfea..0639dd5 100755 --- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h +++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h @@ -397,6 +397,7 @@ public: // Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -410,6 +411,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h index e1907c5..92fe4bd 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h @@ -514,6 +514,7 @@ public: // Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -529,6 +530,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h index 72758a3..d6bcc30 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h @@ -70,6 +70,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief This constructor is used by Dali New() methods. * @@ -77,6 +78,7 @@ public: // Not intended for application developers * @param [in] impl A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL ScrollViewEffect(Internal::ScrollViewEffect *impl); + /// @endcond }; diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h index 5ffd551..951298d 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h @@ -107,12 +107,14 @@ public: protected: + /// @cond internal /** * @brief This constructor is used by Dali New() methods. * @SINCE_1_0.0 * @param [in] impl A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL ScrollViewPagePathEffect( Internal::ScrollViewPagePathEffect *impl ); + /// @endcond }; diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h index 69fbd94..a4545a8 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h @@ -1234,6 +1234,7 @@ public: // Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -1249,6 +1250,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/scrollable/scrollable.h b/dali-toolkit/public-api/controls/scrollable/scrollable.h index 0df8a58..c86c6c7 100644 --- a/dali-toolkit/public-api/controls/scrollable/scrollable.h +++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h @@ -239,6 +239,7 @@ public: // Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -254,6 +255,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/slider/slider.h b/dali-toolkit/public-api/controls/slider/slider.h index 8ba6139..d1cffec 100644 --- a/dali-toolkit/public-api/controls/slider/slider.h +++ b/dali-toolkit/public-api/controls/slider/slider.h @@ -266,8 +266,10 @@ public: // Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. + * * @SINCE_1_1.39 * @param[in] implementation The Control implementation */ @@ -275,10 +277,12 @@ public: // Not intended for application developers /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. + * * @SINCE_1_1.39 * @param[in] internal A pointer to the internal CustomActor */ explicit DALI_INTERNAL Slider( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/table-view/table-view.h b/dali-toolkit/public-api/controls/table-view/table-view.h index 3f199a5..b043d40 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -499,6 +499,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -512,6 +513,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/text-controls/text-editor.h b/dali-toolkit/public-api/controls/text-controls/text-editor.h index 1de3730..fc7b701 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-editor.h +++ b/dali-toolkit/public-api/controls/text-controls/text-editor.h @@ -172,6 +172,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -185,6 +186,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/text-controls/text-label.h b/dali-toolkit/public-api/controls/text-controls/text-label.h index 105690a..c9322aa 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-label.h +++ b/dali-toolkit/public-api/controls/text-controls/text-label.h @@ -317,6 +317,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -332,6 +333,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** diff --git a/dali-toolkit/public-api/controls/video-view/video-view.h b/dali-toolkit/public-api/controls/video-view/video-view.h index e519db1..71b9a45 100644 --- a/dali-toolkit/public-api/controls/video-view/video-view.h +++ b/dali-toolkit/public-api/controls/video-view/video-view.h @@ -209,6 +209,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -224,6 +225,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL VideoView( Dali::Internal::CustomActor* internal ); + /// @endcond }; diff --git a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h index 18f0dbb..96bbed0 100644 --- a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h +++ b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h @@ -287,6 +287,7 @@ public: // Signals // Not intended for application developers + /// @cond internal /** * @brief Creates a new handle from the implementation. * @@ -294,6 +295,7 @@ public: // Signals * @param[in] impl A pointer to the object. */ explicit DALI_INTERNAL KeyboardFocusManager(Internal::KeyboardFocusManager *impl); + /// @endcond }; // class KeyboardFocusManager diff --git a/dali-toolkit/public-api/styling/style-manager.h b/dali-toolkit/public-api/styling/style-manager.h index 54191e4..7b8efbb 100644 --- a/dali-toolkit/public-api/styling/style-manager.h +++ b/dali-toolkit/public-api/styling/style-manager.h @@ -172,6 +172,7 @@ public: // Signals public: + /// @cond internal /** * @brief Allows the creation of a StyleManager handle from an internal pointer. * @@ -180,6 +181,7 @@ public: * @param[in] impl A pointer to the object. */ explicit DALI_INTERNAL StyleManager( Internal::StyleManager *impl ); + /// @endcond }; // class StyleManager