[runtime/api] Add tensorinfo field comment (#9314)
author오형석/On-Device Lab(SR)/Staff Engineer/삼성전자 <hseok82.oh@samsung.com>
Mon, 2 Dec 2019 05:12:19 +0000 (14:12 +0900)
committerGitHub Enterprise <noreply-CODE@samsung.com>
Mon, 2 Dec 2019 05:12:19 +0000 (14:12 +0900)
Add doxygen comment at nnfw_tensorinfo field

Signed-off-by: Hyeongseok Oh <hseok82.oh@samsung.com>
runtime/neurun/api/include/nnfw.h

index 0538ab2..b41239e 100644 (file)
@@ -116,9 +116,15 @@ typedef enum {
  */
 typedef struct nnfw_tensorinfo
 {
+  /** The data type */
   NNFW_TYPE dtype;
-  int rank;
-  int dims[6];
+  /** The number of dimensions (rank) */
+  int32_t rank;
+  /**
+   * The dimension of tensor.
+   * Maximum rank is 6.
+   */
+  int32_t dims[6];
 } nnfw_tensorinfo;
 
 /**