[C-API] Describe the pipeline state as image

This patch describes the the pipeline state as image instead of ASCII
text art.

Signed-off-by: Sangjung Woo <sangjung.woo@samsung.com>

diff --git a/api/capi/doc/images/capi_nnstreamer_pipeline_state.jpg b/api/capi/doc/images/capi_nnstreamer_pipeline_state.jpg
new file mode 100644 (file)
index 0000000..feaa1a1
Binary files /dev/null and b/api/capi/doc/images/capi_nnstreamer_pipeline_state.jpg differ

diff --git a/api/capi/doc/nnstreamer_doc.h b/api/capi/doc/nnstreamer_doc.h
index f93c6f6..364946e 100644 (file)
--- a/api/capi/doc/nnstreamer_doc.h
+++ b/api/capi/doc/nnstreamer_doc.h
@@ -43,6 +43,9 @@
  *
  *  Note that this function set is supposed to be thread-safe.
  *
+ * @subsection CAPI_ML_NNSTREAMER_PIPELINE_STATE_DIAGRAM Pipeline State Diagram
+ * @image html capi_nnstreamer_pipeline_state.jpg "Figure1. Pipeline State" width=12cm
+ *
  * @section CAPI_ML_NNSTREAMER_PIPELINE_FEATURE Related Features
  * This function is related with the following features:\n
  *  - http://tizen.org/feature/machine_learning\n

diff --git a/api/capi/include/nnstreamer.h b/api/capi/include/nnstreamer.h
index 04b55c7..ac8d91c 100644 (file)
--- a/api/capi/include/nnstreamer.h
+++ b/api/capi/include/nnstreamer.h
@@ -168,24 +168,8 @@ typedef enum {
 
 /**
  * @brief Enumeration for pipeline state.
- * @details Refer to https://gstreamer.freedesktop.org/documentation/plugin-development/basics/states.html.
- *          The state diagram of pipeline looks like this, assuming that there are no errors.
- *
- *          [ UNKNOWN ] "new null object"
- *               | "ml_pipeline_construct" starts
- *               V
- *          [  NULL   ] <------------------------------------------+
- *               | "ml_pipeline_construct" creates                |
- *               V                                                 |
- *          [  READY  ]                                            |
- *               | "ml_pipeline_construct' completes              | "ml_pipeline_destroy"
- *               V                                                 |
- *          [         ] ------------------------------------------>|
- *          [  PAUSED ] <-------------------+                      |
- *               | "ml_pipeline_start"     | "ml_pipeline_stop"  |
- *               V                          |                      |
- *          [ PLAYING ] --------------------+----------------------+
- *
+ * @details The pipeline state is described on @ref CAPI_MEDIA_RECORDER_MODULE_PIPELINE_STATE_DIAGRAM.
+ * Refer to https://gstreamer.freedesktop.org/documentation/plugin-development/basics/states.html.
  * @since_tizen 5.5
  */
 typedef enum {