Updated @since tags for APIs added since 1.2.0 that are required for Tizen 3.0

- Some APIs we have added since we did the minor version up are required for Tizen 3.0.
- Cleanest way to do this to ensure the tizen and devel/master branches do not diverge too much is
  by using specific doxygen aliases for the APIs required for Tizen 3.0.

Change-Id: Ibf6dd635add3343000cb0e7edcaa0a3b5cf8aed9

diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in
index 0fedbc6..47266fc 100644 (file)
--- a/build/tizen/docs/dali.doxy.in
+++ b/build/tizen/docs/dali.doxy.in
@@ -346,6 +346,10 @@ ALIASES += SINCE_1_0="@since 1.0"
 ALIASES += SINCE_1_1="@since 1.1"
 ALIASES += SINCE_1_2="@since 1.2"
 
 ALIASES += SINCE_1_1="@since 1.1"
 ALIASES += SINCE_1_2="@since 1.2"
 

+# Extra tags for Tizen 3.0
+ALIASES += SINCE_1_2_2="@since 1.2.2"
+ALIASES += SINCE_1_2_4="@since 1.2.4"
+

 ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0"
 ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1"
 ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"
 ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0"
 ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1"
 ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"


@@ -361,11 +365,17 @@ ALIASES += REMARK_INTERNET=""
 ## For Tizen Native API Reference
 #ALIASES += SINCE_1_0="\par Since:\n 2.4, DALi version 1.0"
 #ALIASES += SINCE_1_1="\par Since:\n 3.0, DALi version 1.1"
 ## For Tizen Native API Reference
 #ALIASES += SINCE_1_0="\par Since:\n 2.4, DALi version 1.0"
 #ALIASES += SINCE_1_1="\par Since:\n 3.0, DALi version 1.1"

+#ALIASES += SINCE_1_2="\par Since:\n 4.0, DALi version 1.2"
+
+## Extra tags for Tizen 3.0
+#ALIASES += SINCE_1_2_2="\par Since:\n 3.0, DALi version 1.2.2"
+#ALIASES += SINCE_1_2_4="\par Since:\n 3.0, DALi version 1.2.4"

 
 ## DALi has no deprecated API in Tizen 2.4 because it's DALi's first release.
 ## Thus deprecated APIs in DALi 1.0.xx will be deprecated in Tizen 3.0.
 #ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 3.0, DALi version 1.0"
 #ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 3.0, DALi version 1.1"
 
 ## DALi has no deprecated API in Tizen 2.4 because it's DALi's first release.
 ## Thus deprecated APIs in DALi 1.0.xx will be deprecated in Tizen 3.0.
 #ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 3.0, DALi version 1.0"
 #ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 3.0, DALi version 1.1"

+#ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 4.0, DALi version 1.2"

 
 #ALIASES += PLATFORM="@platform"
 #ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform"
 
 #ALIASES += PLATFORM="@platform"
 #ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform"

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 e6e05f8..152a8b7 100644 (file)
--- a/dali-toolkit/public-api/controls/text-controls/text-editor.h
+++ b/dali-toolkit/public-api/controls/text-controls/text-editor.h
@@ -43,7 +43,7 @@ class TextEditor;
  * | %Signal Name         | Method                         |                    |
  * |----------------------|--------------------------------|--------------------|
  * | textChanged          | @ref TextChangedSignal()       | @SINCE_1_1.37      |
  * | %Signal Name         | Method                         |                    |
  * |----------------------|--------------------------------|--------------------|
  * | textChanged          | @ref TextChangedSignal()       | @SINCE_1_1.37      |

- * | inputStyleChanged    | @ref InputStyleChangedSignal() | @SINCE_1_2.2       |
+ * | inputStyleChanged    | @ref InputStyleChangedSignal() | @SINCE_1_2_2       |

  *
  */
 class DALI_IMPORT_API TextEditor : public Control
  *
  */
 class DALI_IMPORT_API TextEditor : public Control


@@ -114,22 +114,22 @@ public:
   /**
    * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
    *
   /**
    * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
    *

-   * @SINCE_1_2.2
+   * @SINCE_1_2_2

    */
   struct InputStyle
   {
     enum Mask
     {
    */
   struct InputStyle
   {
     enum Mask
     {

-      NONE         = 0x0000, ///< @SINCE_1_2.2
-      COLOR        = 0x0001, ///< @SINCE_1_2.2
-      FONT_FAMILY  = 0x0002, ///< @SINCE_1_2.2
-      POINT_SIZE   = 0x0004, ///< @SINCE_1_2.2
-      FONT_STYLE   = 0x0008, ///< @SINCE_1_2.2
-      LINE_SPACING = 0x0010, ///< @SINCE_1_2.2
-      UNDERLINE    = 0x0020, ///< @SINCE_1_2.2
-      SHADOW       = 0x0040, ///< @SINCE_1_2.2
-      EMBOSS       = 0x0080, ///< @SINCE_1_2.2
-      OUTLINE      = 0x0100  ///< @SINCE_1_2.2
+      NONE         = 0x0000, ///< @SINCE_1_2_2
+      COLOR        = 0x0001, ///< @SINCE_1_2_2
+      FONT_FAMILY  = 0x0002, ///< @SINCE_1_2_2
+      POINT_SIZE   = 0x0004, ///< @SINCE_1_2_2
+      FONT_STYLE   = 0x0008, ///< @SINCE_1_2_2
+      LINE_SPACING = 0x0010, ///< @SINCE_1_2_2
+      UNDERLINE    = 0x0020, ///< @SINCE_1_2_2
+      SHADOW       = 0x0040, ///< @SINCE_1_2_2
+      EMBOSS       = 0x0080, ///< @SINCE_1_2_2
+      OUTLINE      = 0x0100  ///< @SINCE_1_2_2

     };
   };
 
     };
   };
 


@@ -143,7 +143,7 @@ public:
 
   /**
    * @brief Input Style changed signal type.
 
   /**
    * @brief Input Style changed signal type.

-   * @SINCE_1_2.2
+   * @SINCE_1_2_2

    */
   typedef Signal<void ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
 
    */
   typedef Signal<void ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
 


@@ -223,7 +223,7 @@ public:
    *   void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
    * @endcode
    *
    *   void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
    * @endcode
    *

-   * @SINCE_1_2.2
+   * @SINCE_1_2_2

    * @return The signal to connect to.
    */
   InputStyleChangedSignalType& InputStyleChangedSignal();
    * @return The signal to connect to.
    */
   InputStyleChangedSignalType& InputStyleChangedSignal();

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 f33483c..ddfa4af 100644 (file)
--- a/dali-toolkit/public-api/controls/text-controls/text-field.h
+++ b/dali-toolkit/public-api/controls/text-controls/text-field.h
@@ -44,7 +44,7 @@ class TextField;
  * |----------------------|--------------------------------|--------------------|
  * | textChanged          | @ref TextChangedSignal()       | @SINCE_1_0.0       |
  * | maxLengthReached     | @ref MaxLengthReachedSignal()  | @SINCE_1_0.0       |
  * |----------------------|--------------------------------|--------------------|
  * | textChanged          | @ref TextChangedSignal()       | @SINCE_1_0.0       |
  * | maxLengthReached     | @ref MaxLengthReachedSignal()  | @SINCE_1_0.0       |

- * | inputStyleChanged    | @ref InputStyleChangedSignal() | @SINCE_1_2.2       |
+ * | inputStyleChanged    | @ref InputStyleChangedSignal() | @SINCE_1_2_2       |

  */
 class DALI_IMPORT_API TextField : public Control
 {
  */
 class DALI_IMPORT_API TextField : public Control
 {


@@ -133,21 +133,21 @@ public:
   /**
    * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
    *
   /**
    * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
    *

-   * @SINCE_1_2.2
+   * @SINCE_1_2_2

    */
   struct InputStyle
   {
     enum Mask
     {
    */
   struct InputStyle
   {
     enum Mask
     {

-      NONE         = 0x0000, ///< @SINCE_1_2.2
-      COLOR        = 0x0001, ///< @SINCE_1_2.2
-      FONT_FAMILY  = 0x0002, ///< @SINCE_1_2.2
-      POINT_SIZE   = 0x0004, ///< @SINCE_1_2.2
-      FONT_STYLE   = 0x0008, ///< @SINCE_1_2.2
-      UNDERLINE    = 0x0010, ///< @SINCE_1_2.2
-      SHADOW       = 0x0020, ///< @SINCE_1_2.2
-      EMBOSS       = 0x0040, ///< @SINCE_1_2.2
-      OUTLINE      = 0x0080  ///< @SINCE_1_2.2
+      NONE         = 0x0000, ///< @SINCE_1_2_2
+      COLOR        = 0x0001, ///< @SINCE_1_2_2
+      FONT_FAMILY  = 0x0002, ///< @SINCE_1_2_2
+      POINT_SIZE   = 0x0004, ///< @SINCE_1_2_2
+      FONT_STYLE   = 0x0008, ///< @SINCE_1_2_2
+      UNDERLINE    = 0x0010, ///< @SINCE_1_2_2
+      SHADOW       = 0x0020, ///< @SINCE_1_2_2
+      EMBOSS       = 0x0040, ///< @SINCE_1_2_2
+      OUTLINE      = 0x0080  ///< @SINCE_1_2_2

     };
   };
 
     };
   };
 


@@ -167,7 +167,7 @@ public:
 
   /**
    * @brief Input Style changed signal type.
 
   /**
    * @brief Input Style changed signal type.

-   * @SINCE_1_2.2
+   * @SINCE_1_2_2

    */
   typedef Signal<void ( TextField, InputStyle::Mask ) > InputStyleChangedSignalType;
 
    */
   typedef Signal<void ( TextField, InputStyle::Mask ) > InputStyleChangedSignalType;
 


@@ -256,7 +256,7 @@ public:
    *   void YourCallbackName( TextField textField, TextField::InputStyle::Mask mask );
    * @endcode
    *
    *   void YourCallbackName( TextField textField, TextField::InputStyle::Mask mask );
    * @endcode
    *

-   * @SINCE_1_2.2
+   * @SINCE_1_2_2

    * @return The signal to connect to.
    */
   InputStyleChangedSignalType& InputStyleChangedSignal();
    * @return The signal to connect to.
    */
   InputStyleChangedSignalType& InputStyleChangedSignal();

diff --git a/dali-toolkit/public-api/visuals/primitive-visual-properties.h b/dali-toolkit/public-api/visuals/primitive-visual-properties.h
index 5b04d4e..dbf1e5c 100644 (file)
--- a/dali-toolkit/public-api/visuals/primitive-visual-properties.h
+++ b/dali-toolkit/public-api/visuals/primitive-visual-properties.h
@@ -47,7 +47,7 @@ enum
   /**
    * @brief The color of the shape.
    * @details Name "mixColor", type Property::VECTOR4.
   /**
    * @brief The color of the shape.
    * @details Name "mixColor", type Property::VECTOR4.

-   * @SINCE_1_2.4
+   * @SINCE_1_2_4

    * @note Optional. If not specified, the default is Vector4(0.5, 0.5, 0.5, 1.0).
    * @note Applies to ALL shapes.
    */
    * @note Optional. If not specified, the default is Vector4(0.5, 0.5, 0.5, 1.0).
    * @note Applies to ALL shapes.
    */

diff --git a/dali-toolkit/public-api/visuals/visual-properties.h b/dali-toolkit/public-api/visuals/visual-properties.h
index cab8986..989d938 100644 (file)
--- a/dali-toolkit/public-api/visuals/visual-properties.h
+++ b/dali-toolkit/public-api/visuals/visual-properties.h
@@ -42,7 +42,7 @@ enum Type
   IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45
   MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45
   PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45
   IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45
   MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45
   PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45

-  WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2.2
+  WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2

 };
 
 namespace Property
 };
 
 namespace Property