fix for review

ut-issl · Mar 2, 2023 · a4807bc · a4807bc
1 parent 8cec6b9
commit a4807bc
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/Library/result.h b/Library/result.h
@@ -7,12 +7,12 @@
 
 /**
  * @enum   RESULT
- * @brief  Rust でいうところの Result<T, E> のような，汎用的な返り値用 enum
+ * @brief  Rust でいうところの Result<(), ()> のような，汎用的な成功したかどうかだけの返り値用 enum
  * @note   uint8_t を想定
  */
 typedef enum
 {
-  RESULT_OK = 0,  //!< OK
+  RESULT_OK = 0,  //!< OK （C2A では慣習的に OK 系列挙子は 0 を使うので，万が一他の enum に cast されても事故が起きにくいように）
   RESULT_ERR      //!< Error or NG
 } RESULT;