[runtime/api] Update enum value comment (#9247)

Add more comment for each enum value

Signed-off-by: Hyeongseok Oh <hseok82.oh@samsung.com>

diff --git a/runtime/neurun/api/include/nnfw.h b/runtime/neurun/api/include/nnfw.h
index 2ae9893..0538ab2 100644 (file)
--- a/runtime/neurun/api/include/nnfw.h
+++ b/runtime/neurun/api/include/nnfw.h
@@ -55,8 +55,15 @@ extern "C" {
  */
 typedef struct nnfw_session nnfw_session;
 
+/**
+ * Tensor types
+ *
+ * The type of tensor represented in {@link nnfw_tensorinfo}
+ */
 typedef enum {
+  /** A tensor of 32 bit floating point */
   NNFW_TYPE_TENSOR_FLOAT32 = 0,
+  /** A tensor of 32 bit signed integer */
   NNFW_TYPE_TENSOR_INT32 = 1,
   /**
    * A tensor of 8 bit integers that represent real numbers.
@@ -64,6 +71,7 @@ typedef enum {
    * real_value = (integer_value - zeroPoint) * scale.
    */
   NNFW_TYPE_TENSOR_QUANT8_ASYMM = 2,
+  /** A tensor of boolean */
   NNFW_TYPE_TENSOR_BOOL = 3,
 } NNFW_TYPE;
 
@@ -71,7 +79,9 @@ typedef enum {
  * Result Values
  */
 typedef enum {
+  /** Successful */
   NNFW_STATUS_NO_ERROR = 0,
+  /** Failed */
   NNFW_STATUS_ERROR = 1,
 } NNFW_STATUS;
 
@@ -79,8 +89,17 @@ typedef enum {
  * Data format of a tensor
  */
 typedef enum {
+  /** Don't care layout */
   NNFW_LAYOUT_NONE = 0,
+  /**
+   * Channel last layout
+   * If rank is 4, layout is NHWC
+   */
   NNFW_LAYOUT_CHANNELS_LAST = 1,
+  /**
+   * Channel first layout
+   * If rank is 4, layout is NCHW
+   */
   NNFW_LAYOUT_CHANNELS_FIRST = 2,
 } NNFW_LAYOUT;