[C-Api] Update the doc comment about Tizen privilege.
authorSangjung Woo <sangjung.woo@samsung.com>
Fri, 5 Jul 2019 08:48:49 +0000 (17:48 +0900)
committerMyungJoo Ham <myungjoo.ham@samsung.com>
Mon, 8 Jul 2019 10:22:29 +0000 (19:22 +0900)
This patch updates the the doc comment about Tizen privilege.

Signed-off-by: Sangjung Woo <sangjung.woo@samsung.com>
api/capi/doc/nnstreamer_doc.h
api/capi/include/nnstreamer-single.h
api/capi/include/nnstreamer.h

index 88d5768..c1dda36 100644 (file)
@@ -72,6 +72,8 @@
  * To ensure your application is only running on the device with specific
  * features, please define the features in your manifest file using the manifest
  * editor in the SDK.\n
+ * For example, your application accesses to the camera device,
+ * then you have to add 'http://tizen.org/privilege/camera' into the manifest of your application.\n
  * More details on featuring your application can be found from
  * <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature">
  *    <b>Feature Element</b>.
  * To ensure your application is only running on the device with specific
  * features, please define the features in your manifest file using the manifest
  * editor in the SDK.\n
+ * For example, your application accesses to the camera device,
+ * then you have to add 'http://tizen.org/privilege/camera' into the manifest of your application.\n
  * More details on featuring your application can be found from
  * <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature">
  *    <b>Feature Element</b>.
index a322603..443264c 100644 (file)
@@ -52,6 +52,8 @@ typedef void *ml_single_h;
  * @details Even if the model has flexible input data dimensions,
  *          input data frames of an instance of a model should share the same dimension.
  * @since_tizen 5.5
+ * @remarks http://tizen.org/privilege/mediastorage is needed if @a model is relevant to media storage.
+ * @remarks http://tizen.org/privilege/externalstorage is needed if @a model is relevant to external storage.
  * @param[out] single This is the model handle opened. Users are required to close
  *                   the given instance with ml_single_close().
  * @param[in] model This is the path to the neural network model file.
index 049f110..fc32b53 100644 (file)
@@ -236,6 +236,8 @@ typedef void (*ml_pipeline_state_cb) (ml_pipeline_state_e state, void *user_data
  * @details Use this function to create gst_parse_launch compatible NNStreamer pipelines.
  * @since_tizen 5.5
  * @remarks If the function succeeds, @a pipe handle must be released using ml_pipeline_destroy().
+ * @remarks http://tizen.org/privilege/mediastorage is needed if @a pipeline_description is relevant to media storage.
+ * @remarks http://tizen.org/privilege/externalstorage is needed if @a pipeline_description is relevant to external storage.
  * @param[in] pipeline_description The pipeline description compatible with GStreamer gst_parse_launch(). Refer to GStreamer manual or NNStreamer (github.com/nnsuite/nnstreamer) documentation for examples and the grammar.
  * @param[in] cb The function to be called when the pipeline state is changed. You may set NULL if it's not required.
  * @param[in] user_data Private data for the callback. This value is passed to the callback when it's invoked.