From: Yoonsang Lee Date: Thu, 24 Sep 2015 07:46:10 +0000 (+0900) Subject: Modify doxygen group names X-Git-Tag: dali_1.1.4~1^2 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=bea7b708b28cb38349ff99c3a656d40c065a8c54 Modify doxygen group names - "-" in group names causes javascript errors when used in doxygen 1.7.6.1 with GENERATE_TREEVIEW option - by which Tizen API reference is generated (not sure for later version) - It makes DALi items in the tree view cannot be opened. - Replace all "-" to "_" in doxygen group names to solve the problem. - Arrange redundant doxygen input path Change-Id: I203b63f685b7a7d6846337c4c395913d584cf2ec --- diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index 3fa2e57..f9a5f53 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -761,7 +761,7 @@ 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 \ - @prefix@/include/dali \ + @prefix@/include/dali/public-api \ ../../../../dali-toolkit/dali-toolkit/public-api \ ../../../automated-tests/README.md diff --git a/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h b/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h index 08ce8ce..b244aca 100644 --- a/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h +++ b/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h @@ -33,7 +33,7 @@ namespace Internal DALI_INTERNAL class AccessibilityManager; } /** - * @addtogroup dali-toolkit-accessibility-manager + * @addtogroup dali_toolkit_accessibility_manager * @{ */ diff --git a/dali-toolkit/public-api/controls/alignment/alignment.h b/dali-toolkit/public-api/controls/alignment/alignment.h index 5a9d56c..a879c48 100644 --- a/dali-toolkit/public-api/controls/alignment/alignment.h +++ b/dali-toolkit/public-api/controls/alignment/alignment.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class Alignment; } /** - * @addtogroup dali-toolkit-controls-alignment + * @addtogroup dali_toolkit_controls_alignment * @{ */ diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index 34ea28f..4c40ac8 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class Button; } /** - * @addtogroup dali-toolkit-controls-buttons + * @addtogroup dali_toolkit_controls_buttons * @{ */ 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 357c3e1..7a5e073 100644 --- a/dali-toolkit/public-api/controls/buttons/check-box-button.h +++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h @@ -34,7 +34,7 @@ namespace Internal DALI_INTERNAL class CheckBoxButton; } /** - * @addtogroup dali-toolkit-controls-buttons + * @addtogroup dali_toolkit_controls_buttons * @{ */ diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 313d7d0..31684b3 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -36,7 +36,7 @@ namespace Internal DALI_INTERNAL class PushButton; } /** - * @addtogroup dali-toolkit-controls-buttons + * @addtogroup dali_toolkit_controls_buttons * @{ */ diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h index 7c04b42..e597ca1 100644 --- a/dali-toolkit/public-api/controls/buttons/radio-button.h +++ b/dali-toolkit/public-api/controls/buttons/radio-button.h @@ -36,7 +36,7 @@ namespace Internal DALI_INTERNAL class RadioButton; } /** - * @addtogroup dali-toolkit-controls-buttons + * @addtogroup dali_toolkit_controls_buttons * @{ */ diff --git a/dali-toolkit/public-api/controls/control-depth-index-ranges.h b/dali-toolkit/public-api/controls/control-depth-index-ranges.h index ff5732c..5651b04 100644 --- a/dali-toolkit/public-api/controls/control-depth-index-ranges.h +++ b/dali-toolkit/public-api/controls/control-depth-index-ranges.h @@ -24,7 +24,7 @@ namespace Dali namespace Toolkit { /** - * @addtogroup dali-toolkit-controls + * @addtogroup dali_toolkit_controls * @{ */ diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index b8ae6bb..4a8466d 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -36,7 +36,7 @@ namespace Dali namespace Toolkit { /** - * @addtogroup dali-toolkit-controls + * @addtogroup dali_toolkit_controls * @{ */ diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index bac8835..d6425e2 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -41,7 +41,7 @@ namespace Internal class Control; } /** - * @addtogroup dali-toolkit-controls + * @addtogroup dali_toolkit_controls * @{ */ 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 a2c5ea6..10f05a9 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 @@ -50,7 +50,7 @@ class BloomView; } // namespace Internal /** - * @addtogroup dali-toolkit-controls-gaussian-blur-view + * @addtogroup dali_toolkit_controls_gaussian_blur_view * @{ */ 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 6fa3474..a65f649 100644 --- a/dali-toolkit/public-api/controls/image-view/image-view.h +++ b/dali-toolkit/public-api/controls/image-view/image-view.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class ImageView; } /** - * @addtogroup dali-toolkit-controls-image-view + * @addtogroup dali_toolkit_controls_image_view * @{ */ 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 3f1ad10..f513a3e 100755 --- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h +++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h @@ -34,7 +34,7 @@ namespace Internal DALI_INTERNAL class ScrollBar; } /** - * @addtogroup dali-toolkit-controls-scroll-bar + * @addtogroup dali_toolkit_controls_scroll_bar * @{ */ diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h b/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h index 8299d84..56de533 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h @@ -27,7 +27,7 @@ namespace Dali namespace Toolkit { /** - * @addtogroup dali-toolkit-controls-item-view + * @addtogroup dali_toolkit_controls_item_view * @{ */ diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h index 84ef7b7..22e5261 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h @@ -27,7 +27,7 @@ namespace Dali namespace Toolkit { /** - * @addtogroup dali-toolkit-controls-item-view + * @addtogroup dali_toolkit_controls_item_view * @{ */ diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h index 9302e8a..51f051a 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h @@ -31,7 +31,7 @@ namespace Dali namespace Toolkit { /** - * @addtogroup dali-toolkit-controls-item-view + * @addtogroup dali_toolkit_controls_item_view * @{ */ diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h index 7388bfa..0f79dc2 100644 --- a/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h +++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h @@ -29,7 +29,7 @@ namespace Dali namespace Toolkit { /** - * @addtogroup dali-toolkit-controls-item-view + * @addtogroup dali_toolkit_controls_item_view * @{ */ 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 2790194..38b5856 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 @@ -35,7 +35,7 @@ namespace Internal DALI_INTERNAL class ItemView; } /** - * @addtogroup dali-toolkit-controls-item-view + * @addtogroup dali_toolkit_controls_item_view * @{ */ diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h index 15a29d6..50962f2 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h @@ -32,7 +32,7 @@ class PropertyInput; namespace Toolkit { /** - * @addtogroup dali-toolkit-controls-scroll-view + * @addtogroup dali_toolkit_controls_scroll_view * @{ */ 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 4af0442..73b97b0 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 @@ -38,7 +38,7 @@ class ScrollViewEffect; class ScrollViewWobbleEffect; } /** - * @addtogroup dali-toolkit-controls-scroll-view + * @addtogroup dali_toolkit_controls_scroll_view * @{ */ 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 af59f83..4939ac7 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 @@ -35,7 +35,7 @@ namespace Internal DALI_INTERNAL class ScrollViewPagePathEffect; } /** - * @addtogroup dali-toolkit-controls-scroll-view + * @addtogroup dali_toolkit_controls_scroll_view * @{ */ 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 508b3d2..7ebb168 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 @@ -35,7 +35,7 @@ namespace Internal DALI_INTERNAL class ScrollView; } /** - * @addtogroup dali-toolkit-controls-scroll-view + * @addtogroup dali_toolkit_controls_scroll_view * @{ */ diff --git a/dali-toolkit/public-api/controls/scrollable/scrollable.h b/dali-toolkit/public-api/controls/scrollable/scrollable.h index d43a29a..a7fd42b 100644 --- a/dali-toolkit/public-api/controls/scrollable/scrollable.h +++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class Scrollable; } /** - * @addtogroup dali-toolkit-controls-scrollable + * @addtogroup dali_toolkit_controls_scrollable * @{ */ 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 eb03b9e..d3a9517 100644 --- a/dali-toolkit/public-api/controls/table-view/table-view.h +++ b/dali-toolkit/public-api/controls/table-view/table-view.h @@ -36,7 +36,7 @@ namespace Internal DALI_INTERNAL class TableView; } /** - * @addtogroup dali-toolkit-controls-table-view + * @addtogroup dali_toolkit_controls_table_view * @{ */ diff --git a/dali-toolkit/public-api/controls/text-controls/text-field.h b/dali-toolkit/public-api/controls/text-controls/text-field.h index 7b9d11b..ea6da67 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-field.h +++ b/dali-toolkit/public-api/controls/text-controls/text-field.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class TextField; } /** - * @addtogroup dali-toolkit-controls-text-controls + * @addtogroup dali_toolkit_controls_text_controls * @{ */ 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 7669b05..6e4931e 100644 --- a/dali-toolkit/public-api/controls/text-controls/text-label.h +++ b/dali-toolkit/public-api/controls/text-controls/text-label.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class TextLabel; } /** - * @addtogroup dali-toolkit-controls-text-controls + * @addtogroup dali_toolkit_controls_text_controls * @{ */ diff --git a/dali-toolkit/public-api/enums.h b/dali-toolkit/public-api/enums.h index ff678a9..f3f893f 100644 --- a/dali-toolkit/public-api/enums.h +++ b/dali-toolkit/public-api/enums.h @@ -29,7 +29,7 @@ namespace Dali namespace Toolkit { /** - * @addtogroup dali-toolkit-controls + * @addtogroup dali_toolkit_controls * @{ */ 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 3b6b33f..da38050 100644 --- a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h +++ b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class KeyboardFocusManager; } /** - * @addtogroup dali-toolkit-focus-manager + * @addtogroup dali_toolkit_focus_manager * @{ */ diff --git a/doc/dali-toolkit-doc.h b/doc/dali-toolkit-doc.h index 2cb0f1a..fb83355 100644 --- a/doc/dali-toolkit-doc.h +++ b/doc/dali-toolkit-doc.h @@ -16,56 +16,56 @@ * * - * @defgroup dali-toolkit DALi Toolkit + * @defgroup dali_toolkit DALi Toolkit * @ingroup dali * - * @brief This module provides UI components and various effects on top of the dali-core. + * @brief This module provides UI components and various effects on top of the DALi Core. * * @{ - * @defgroup dali-toolkit-accessibility-manager Accessibility Manager + * @defgroup dali_toolkit_accessibility_manager Accessibility Manager * @brief AccessibilityManager manages a accessibility focus chain. - * @defgroup dali-toolkit-controls Controls + * @defgroup dali_toolkit_controls Controls * @brief Controls are interactive components for layouting the user interface. * @{ - * @defgroup dali-toolkit-controls-alignment Alignment + * @defgroup dali_toolkit_controls_alignment Alignment * @brief Alignment is a container which provides an easy way to align other actors inside its boundary. - * @defgroup dali-toolkit-controls-buttons Buttons + * @defgroup dali_toolkit_controls_buttons Buttons * @brief Button is a small object on UI that you can press. - * @defgroup dali-toolkit-controls-gaussian-blur-view Gaussian Blur View + * @defgroup dali_toolkit_controls_gaussian_blur_view Gaussian Blur View * @brief GaussianBlurView provides a render process that blurs an image. - * @defgroup dali-toolkit-controls-image-view Image View + * @defgroup dali_toolkit_controls_image_view Image View * @brief ImageView is a control displying an image. - * @defgroup dali-toolkit-controls-scroll-bar Scroll Bar + * @defgroup dali_toolkit_controls_scroll_bar Scroll Bar * @brief ScrollBar control. - * @defgroup dali-toolkit-controls-scrollable Scrollable + * @defgroup dali_toolkit_controls_scrollable Scrollable * @brief Scrollable container controls. * @{ - * @defgroup dali-toolkit-controls-item-view Item View + * @defgroup dali_toolkit_controls_item_view Item View * @brief ItemView class is a scrollable container that can contain many items. - * @defgroup dali-toolkit-controls-scroll-view Scroll View - * @brief ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning. + * @defgroup dali_toolkit_controls_scroll_view Scroll View + * @brief ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning. * @} - * @defgroup dali-toolkit-controls-table-view Table View + * @defgroup dali_toolkit_controls_table_view Table View * @brief TableView class is a layout container for aligning child actors in a grid like layout. - * @defgroup dali-toolkit-controls-text-controls Text Controls + * @defgroup dali_toolkit_controls_text_controls Text Controls * @brief Controls for displaying text or text input. * @} - * @defgroup dali-toolkit-focus-manager Focus Manager + * @defgroup dali_toolkit_focus_manager Focus Manager * @brief Classes for handling keyboard navigation and maintaining the two dimensional keyboard focus chain. * @}