Add Privilege doxygen tag about URL

- To access to internet, media storage, and external storage in Tizen,
 the user has to add the privileges.

Change-Id: I740227b1e1d0b463fce35755ab272a6749d8b543
Signed-off-by: Seoyeon Kim <seoyeon2.kim@samsung.com>

diff --git a/build/tizen/docs-internal/dali-internal.doxy.in b/build/tizen/docs-internal/dali-internal.doxy.in
index b4c92ce..fce6213 100644 (file)
--- a/build/tizen/docs-internal/dali-internal.doxy.in
+++ b/build/tizen/docs-internal/dali-internal.doxy.in
@@ -351,28 +351,55 @@ ALIASES += clip{3}="\dontinclude \1 \n \skip \2 \n \until \3"
 # For Open Source DALi API Reference
 ALIASES += SINCE_1_0="@since 1.0"
 ALIASES += SINCE_1_1="@since 1.1"
 # For Open Source DALi API Reference
 ALIASES += SINCE_1_0="@since 1.0"
 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 += SINCE_1_2_5="@since 1.2.5"
+ALIASES += SINCE_1_2_10="@since 1.2.10"
+ALIASES += SINCE_1_2_14="@since 1.2.14"

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

+ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 1.2.10"
+ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"

 
 ALIASES += PLATFORM=""
 ALIASES += PRIVLEVEL_PLATFORM=""
 
 ALIASES += PLATFORM=""
 ALIASES += PRIVLEVEL_PLATFORM=""

+ALIASES += PRIVLEVEL_PUBLIC=""

 ALIASES += PRIVILEGE_KEYGRAB=""
 ALIASES += PRIVILEGE_KEYGRAB=""

+ALIASES += PRIVILEGE_DISPLAY=""
+ALIASES += REMARK_INTERNET=""
+ALIASES += REMARK_STORAGE=""

 
 ############################################
 ## 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"
+#ALIASES += SINCE_1_2_5="\par Since:\n 3.0, DALi version 1.2.5"
+#ALIASES += SINCE_1_2_10="\par Since:\n 3.0, DALi version 1.2.10"
+#ALIASES += SINCE_1_2_14="\par Since:\n 3.0, DALi version 1.2.14"

 
 ## 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_10="@deprecated Deprecated since 3.0, DALi version 1.2.10"
+#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"

+#ALIASES += PRIVLEVEL_PUBLIC="\par Privilege Level:\n public"

 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"
 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"

-
+#ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display"
+#ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address."
+#ALIASES += REMARK_STORAGE="@remarks %http://tizen.org/privilege/mediastorage is needed if @a url is relevant to media storage. @remarks %http://tizen.org/privilege/externalstorage is needed if @a url is relevant to external storage."

 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"

diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in
index 6007065..69e8acb 100644 (file)
--- a/build/tizen/docs/dali.doxy.in
+++ b/build/tizen/docs/dali.doxy.in
@@ -364,6 +364,7 @@ ALIASES += PRIVLEVEL_PUBLIC=""
 ALIASES += PRIVILEGE_KEYGRAB=""
 ALIASES += PRIVILEGE_DISPLAY=""
 ALIASES += REMARK_INTERNET=""
 ALIASES += PRIVILEGE_KEYGRAB=""
 ALIASES += PRIVILEGE_DISPLAY=""
 ALIASES += REMARK_INTERNET=""

+ALIASES += REMARK_STORAGE=""

 
 ############################################
 ## For Tizen Native API Reference
 
 ############################################
 ## For Tizen Native API Reference


@@ -391,7 +392,7 @@ ALIASES += REMARK_INTERNET=""
 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"
 #ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display"
 #ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address."
 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"
 #ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display"
 #ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address."

-
+#ALIASES += REMARK_STORAGE="@remarks %http://tizen.org/privilege/mediastorage is needed if @a url is relevant to media storage. @remarks %http://tizen.org/privilege/externalstorage is needed if @a url is relevant to external storage."

 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"

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 d58e239..4585657 100644 (file)
--- a/dali-toolkit/public-api/controls/image-view/image-view.h
+++ b/dali-toolkit/public-api/controls/image-view/image-view.h
@@ -143,6 +143,8 @@ public:
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_0.0
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_0.0

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    * @param[in] url The url of the image resource to display.
    * @return A handle to a newly allocated ImageView.
    */
    * @param[in] url The url of the image resource to display.
    * @return A handle to a newly allocated ImageView.
    */


@@ -154,6 +156,8 @@ public:
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    * @param[in] url The url of the image resource to display.
    * @param [in] size The width and height to which to fit the loaded image.
    * @return A handle to a newly allocated ImageView.
    * @param[in] url The url of the image resource to display.
    * @param [in] size The width and height to which to fit the loaded image.
    * @return A handle to a newly allocated ImageView.


@@ -218,6 +222,8 @@ public:
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.4
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.4

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    * @param[in] url The URL to the image resource to display.
    */
   void SetImage( const std::string& url );
    * @param[in] url The URL to the image resource to display.
    */
   void SetImage( const std::string& url );


@@ -228,6 +234,8 @@ public:
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    * @param[in] url The URL to the image resource to display.
    * @param [in] size The width and height to fit the loaded image to.
    */
    * @param[in] url The URL to the image resource to display.
    * @param [in] size The width and height to fit the loaded image to.
    */

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 561ca2c..8fa6fcc 100644 (file)
--- a/dali-toolkit/public-api/controls/video-view/video-view.h
+++ b/dali-toolkit/public-api/controls/video-view/video-view.h
@@ -121,6 +121,8 @@ public:
    * If the string is empty, VideoView will not display anything
    *
    * @SINCE_1_1.38
    * If the string is empty, VideoView will not display anything
    *
    * @SINCE_1_1.38

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    * @param[in] url The url of the video resource to display
    * @return A handle to a newly allocated Dali VideoView
    */
    * @param[in] url The url of the video resource to display
    * @return A handle to a newly allocated Dali VideoView
    */

diff --git a/dali-toolkit/public-api/image-loader/async-image-loader.h b/dali-toolkit/public-api/image-loader/async-image-loader.h
index 844d758..3472fc0 100644 (file)
--- a/dali-toolkit/public-api/image-loader/async-image-loader.h
+++ b/dali-toolkit/public-api/image-loader/async-image-loader.h
@@ -156,6 +156,8 @@ public:
    * orientationCorrection = true
    *
    * @SINCE_1_2_14
    * orientationCorrection = true
    *
    * @SINCE_1_2_14

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    *
    * @param[in] url The URL of the image file to load.
    * @return The loading task id.
    *
    * @param[in] url The URL of the image file to load.
    * @return The loading task id.


@@ -170,6 +172,8 @@ public:
    * orientationCorrection = true
    *
    * @SINCE_1_2_14
    * orientationCorrection = true
    *
    * @SINCE_1_2_14

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    *
    * @param[in] url The URL of the image file to load.
    * @param[in] dimensions The width and height to fit the loaded image to.
    *
    * @param[in] url The URL of the image file to load.
    * @param[in] dimensions The width and height to fit the loaded image to.


@@ -180,6 +184,8 @@ public:
   /**
    * @brief Start an image loading task.
    * @SINCE_1_2_14
   /**
    * @brief Start an image loading task.
    * @SINCE_1_2_14

+   * @REMARK_INTERNET
+   * @REMARK_STORAGE

    *
    * @param[in] url The URL of the image file to load.
    * @param[in] dimensions The width and height to fit the loaded image to.
    *
    * @param[in] url The URL of the image file to load.
    * @param[in] dimensions The width and height to fit the loaded image to.

diff --git a/dali-toolkit/public-api/image-loader/sync-image-loader.h b/dali-toolkit/public-api/image-loader/sync-image-loader.h
index 1586218..c065664 100644 (file)
--- a/dali-toolkit/public-api/image-loader/sync-image-loader.h
+++ b/dali-toolkit/public-api/image-loader/sync-image-loader.h
@@ -56,6 +56,8 @@ namespace SyncImageLoader
  * orientationCorrection = true
  *
  * @SINCE_1_2_14
  * orientationCorrection = true
  *
  * @SINCE_1_2_14

+ * @REMARK_INTERNET
+ * @REMARK_STORAGE

  *
  * @param[in] url The URL of the image file to load.
  * @return A PixelData object containing the image, or an invalid object on failure.
  *
  * @param[in] url The URL of the image file to load.
  * @return A PixelData object containing the image, or an invalid object on failure.


@@ -70,6 +72,8 @@ DALI_IMPORT_API PixelData Load( const std::string& url );
  * orientationCorrection = true
  *
  * @SINCE_1_2_14
  * orientationCorrection = true
  *
  * @SINCE_1_2_14

+ * @REMARK_INTERNET
+ * @REMARK_STORAGE

  *
  * @param[in] url The URL of the image file to load.
  * @param[in] dimensions The width and height to fit the loaded image to.
  *
  * @param[in] url The URL of the image file to load.
  * @param[in] dimensions The width and height to fit the loaded image to.


@@ -80,6 +84,8 @@ DALI_IMPORT_API PixelData Load( const std::string& url, ImageDimensions dimensio
 /**
  * @brief Load an image synchronously by specifying the target dimensions and options.
  * @SINCE_1_2_14
 /**
  * @brief Load an image synchronously by specifying the target dimensions and options.
  * @SINCE_1_2_14

+ * @REMARK_INTERNET
+ * @REMARK_STORAGE

  *
  * @param[in] url The URL of the image file to load.
  * @param[in] dimensions The width and height to fit the loaded image to.
  *
  * @param[in] url The URL of the image file to load.
  * @param[in] dimensions The width and height to fit the loaded image to.