From a0e92a9491568cd1ad2232bc24b9856914b322f5 Mon Sep 17 00:00:00 2001 From: taeyoon Date: Wed, 10 Aug 2016 14:37:08 +0900 Subject: [PATCH] [3.0] Exclude internal tag module in Public API reference This reverts commit a55bef8df7a2603cee6c4449b4183070733a2e8d. Change-Id: Ifcd5e65cce10769ec4d4fb7dceef63c7363f5ff9 --- dali-toolkit/public-api/controls/alignment/alignment.h | 2 ++ dali-toolkit/public-api/controls/buttons/button.h | 2 ++ dali-toolkit/public-api/controls/buttons/check-box-button.h | 2 ++ dali-toolkit/public-api/controls/buttons/push-button.h | 2 ++ dali-toolkit/public-api/controls/buttons/radio-button.h | 2 ++ dali-toolkit/public-api/controls/control-impl.h | 3 +++ dali-toolkit/public-api/controls/control.h | 2 ++ dali-toolkit/public-api/controls/flex-container/flex-container.h | 2 ++ .../public-api/controls/gaussian-blur-view/gaussian-blur-view.h | 2 ++ dali-toolkit/public-api/controls/image-view/image-view.h | 2 ++ dali-toolkit/public-api/controls/model3d-view/model3d-view.h | 2 ++ .../public-api/controls/page-turn-view/page-turn-landscape-view.h | 2 ++ .../public-api/controls/page-turn-view/page-turn-portrait-view.h | 2 ++ dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h | 2 ++ dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h | 2 ++ dali-toolkit/public-api/controls/scrollable/item-view/item-view.h | 2 ++ .../public-api/controls/scrollable/scroll-view/scroll-view-effect.h | 1 + .../controls/scrollable/scroll-view/scroll-view-page-path-effect.h | 1 + dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h | 2 ++ dali-toolkit/public-api/controls/scrollable/scrollable.h | 2 ++ dali-toolkit/public-api/controls/slider/slider.h | 4 ++++ dali-toolkit/public-api/controls/table-view/table-view.h | 2 ++ dali-toolkit/public-api/controls/text-controls/text-editor.h | 2 ++ dali-toolkit/public-api/controls/text-controls/text-label.h | 2 ++ dali-toolkit/public-api/controls/video-view/video-view.h | 2 ++ dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h | 1 + dali-toolkit/public-api/styling/style-manager.h | 1 + 27 files changed, 53 insertions(+) diff --git a/dali-toolkit/public-api/controls/alignment/alignment.h b/dali-toolkit/public-api/controls/alignment/alignment.h index a5360d7..79ca65c 100644 --- a/dali-toolkit/public-api/controls/alignment/alignment.h +++ b/dali-toolkit/public-api/controls/alignment/alignment.h @@ -237,6 +237,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -245,6 +246,7 @@ public: // Not intended for application developers DALI_INTERNAL Alignment( Internal::Alignment& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index 8893d88..b6e2eec 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -521,6 +521,7 @@ public: //Signals public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -529,6 +530,7 @@ public: // Not intended for application developers DALI_INTERNAL Button( Internal::Button& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 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..17463dd 100644 --- a/dali-toolkit/public-api/controls/buttons/check-box-button.h +++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h @@ -106,6 +106,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 * @param[in] implementation The Control implementation. @@ -113,6 +114,7 @@ public: // Not intended for application developers DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 0b03907..894082b 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -220,6 +220,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -228,6 +229,7 @@ public: // Not intended for application developers DALI_INTERNAL PushButton( Internal::PushButton& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h index 110a6a6..1266d4a 100644 --- a/dali-toolkit/public-api/controls/buttons/radio-button.h +++ b/dali-toolkit/public-api/controls/buttons/radio-button.h @@ -148,6 +148,7 @@ class DALI_IMPORT_API RadioButton: public Button public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -156,6 +157,7 @@ class DALI_IMPORT_API RadioButton: public Button DALI_INTERNAL RadioButton( Internal::RadioButton& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 8b24a6f..8b7b045 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -252,12 +252,14 @@ public: bool IsKeyboardFocusGroup(); /** + * @internal * @brief Called by the AccessibilityManager to activate the Control. * @SINCE_1_0.0 */ DALI_INTERNAL void AccessibilityActivate(); /** + * @internal * @brief Called by the KeyboardFocusManager. * @SINCE_1_0.0 */ @@ -281,6 +283,7 @@ public: Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); /** + * @internal * @brief Called by the KeyInputFocusManager to emit key event signals. * * @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index cdeee6b..613307a 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -412,6 +412,7 @@ public: // Intended for control developers public: // Templates for Deriving Classes /** + * @internal * @brief Template to allow deriving controls to DownCast handles to deriving handle classes. * * @tparam T The handle class @@ -443,6 +444,7 @@ public: // Templates for Deriving Classes } /** + * @internal * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an * implementation of their class. * 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..2b96061 100644 --- a/dali-toolkit/public-api/controls/flex-container/flex-container.h +++ b/dali-toolkit/public-api/controls/flex-container/flex-container.h @@ -272,6 +272,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_1.35 * @@ -280,6 +281,7 @@ public: // Not intended for application developers DALI_INTERNAL FlexContainer( Internal::FlexContainer& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * @SINCE_1_1.35 * 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..c8242a2 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 @@ -299,6 +299,7 @@ public: // Signals public: /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 * @param[in] implementation The UI Control implementation. @@ -306,6 +307,7 @@ public: DALI_INTERNAL GaussianBlurView( Internal::GaussianBlurView& implementation ); /** + * @internal * @brief Allows the creation of this UI Control from an Internal::CustomActor pointer. * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. 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..56b0f5f 100644 --- a/dali-toolkit/public-api/controls/image-view/image-view.h +++ b/dali-toolkit/public-api/controls/image-view/image-view.h @@ -243,6 +243,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -251,6 +252,7 @@ public: // Not intended for application developers DALI_INTERNAL ImageView( Internal::ImageView& implementation ); /** + * @internal * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer. * * @SINCE_1_0.0 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..ccb34da 100644 --- a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h +++ b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h @@ -144,6 +144,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_1.4 @@ -152,6 +153,7 @@ public: // Not intended for application developers DALI_INTERNAL Model3dView( Internal::Model3dView& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_1.4 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..bd34929 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 @@ -88,6 +88,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 * @param[in] implementation The Control implementation. @@ -95,6 +96,7 @@ public: // Not intended for application developers DALI_INTERNAL PageTurnLandscapeView( Internal::PageTurnLandscapeView& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. 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..dfd9a86 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 @@ -89,6 +89,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_1.4 * @param[in] implementation The Control implementation. @@ -96,6 +97,7 @@ public: // Not intended for application developers DALI_INTERNAL PageTurnPortraitView( Internal::PageTurnPortraitView& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * @SINCE_1_1.4 * @param[in] internal A pointer to the internal CustomActor. 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..2f044bd 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 @@ -183,6 +183,7 @@ public: //Signal public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_1.4 * @param[in] implementation The Control implementation. @@ -190,6 +191,7 @@ public: // Not intended for application developers DALI_INTERNAL PageTurnView(Internal::PageTurnView& implementation); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * @SINCE_1_1.4 * @param[in] internal A pointer to the internal CustomActor. 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..8e77b50 100755 --- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h +++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h @@ -398,6 +398,7 @@ public: // Signals public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 * @param[in] implementation The Control implementation. @@ -405,6 +406,7 @@ public: // Not intended for application developers DALI_INTERNAL ScrollBar( Internal::ScrollBar& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. 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..cdbfa34 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 @@ -515,6 +515,7 @@ public: // Signals public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -523,6 +524,7 @@ public: // Not intended for application developers DALI_INTERNAL ItemView(Internal::ItemView& implementation); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 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..57fd52e 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 @@ -71,6 +71,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief This constructor is used by Dali New() methods. * * @SINCE_1_0.0 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..cfbc1ca 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 @@ -108,6 +108,7 @@ public: protected: /** + * @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 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..3d33d7c 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 @@ -1235,6 +1235,7 @@ public: // Signals public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -1243,6 +1244,7 @@ public: // Not intended for application developers DALI_INTERNAL ScrollView(Internal::ScrollView& implementation); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/controls/scrollable/scrollable.h b/dali-toolkit/public-api/controls/scrollable/scrollable.h index 0df8a58..e3cc844 100644 --- a/dali-toolkit/public-api/controls/scrollable/scrollable.h +++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h @@ -240,6 +240,7 @@ public: // Signals public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -248,6 +249,7 @@ public: // Not intended for application developers DALI_INTERNAL Scrollable(Internal::Scrollable& implementation); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/controls/slider/slider.h b/dali-toolkit/public-api/controls/slider/slider.h index 8ba6139..d1fec07 100644 --- a/dali-toolkit/public-api/controls/slider/slider.h +++ b/dali-toolkit/public-api/controls/slider/slider.h @@ -267,14 +267,18 @@ public: // Signals public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. + * * @SINCE_1_1.39 * @param[in] implementation The Control implementation */ DALI_INTERNAL Slider(Internal::Slider& implementation); /** + * @internal * @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 */ 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..5f9dd41 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -500,6 +500,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 * @param[in] implementation The Control implementation. @@ -507,6 +508,7 @@ public: // Not intended for application developers DALI_INTERNAL TableView(Internal::TableView& implementation); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. 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..f9cdff4 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-editor.h +++ b/dali-toolkit/public-api/controls/text-controls/text-editor.h @@ -173,6 +173,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @param[in] implementation The Control implementation. @@ -180,6 +181,7 @@ public: // Not intended for application developers DALI_INTERNAL TextEditor( Internal::TextEditor& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @param[in] internal A pointer to the internal CustomActor. 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..557c419 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-label.h +++ b/dali-toolkit/public-api/controls/text-controls/text-label.h @@ -318,6 +318,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 @@ -326,6 +327,7 @@ public: // Not intended for application developers DALI_INTERNAL TextLabel( Internal::TextLabel& implementation ); /** + * @internal * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 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..ae4c612 100644 --- a/dali-toolkit/public-api/controls/video-view/video-view.h +++ b/dali-toolkit/public-api/controls/video-view/video-view.h @@ -210,6 +210,7 @@ public: public: // Not intended for application developers /** + * @internal * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_1.38 @@ -218,6 +219,7 @@ public: // Not intended for application developers DALI_INTERNAL VideoView( Internal::VideoView& implementation ); /** + * @internal * @brief Allows the creation of this VideoView from an Internal::CustomActor pointer. * * @SINCE_1_1.38 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..374d7ed 100644 --- a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h +++ b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h @@ -288,6 +288,7 @@ public: // Signals // Not intended for application developers /** + * @internal * @brief Creates a new handle from the implementation. * * @SINCE_1_0.0 diff --git a/dali-toolkit/public-api/styling/style-manager.h b/dali-toolkit/public-api/styling/style-manager.h index 54191e4..1e27c90 100644 --- a/dali-toolkit/public-api/styling/style-manager.h +++ b/dali-toolkit/public-api/styling/style-manager.h @@ -173,6 +173,7 @@ public: // Signals public: /** + * @internal * @brief Allows the creation of a StyleManager handle from an internal pointer. * * @note Not intended for application developers -- 2.7.4