From a4807bc8e35c841a954fc7a7d9993997e3bfd44b Mon Sep 17 00:00:00 2001
From: Ryo Suzumoto <ryo.suzumoto@gmail.com>
Date: Thu, 2 Mar 2023 20:52:33 +0900
Subject: [PATCH] fix for review

---
 Library/result.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Library/result.h b/Library/result.h
index aaa2dd3bd..d5ffb057f 100644
--- 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;