Jun Furutani / libMiMic

This is Webservice SDK for mbed. LPCXpresso1769/LPC1768/FRDM-K64F/LPC4088

Fork of libMiMic by Ryo Iizuka

Diff: core/NyLPC_cStr.h

Revision:
48:00d211aac2ec
Parent:
2:b96c1e90d120
Child:
57:bc4330dfa62f
--- a/core/NyLPC_cStr.h	Sun Jul 28 01:07:37 2013 +0000
+++ b/core/NyLPC_cStr.h	Wed Aug 07 13:53:02 2013 +0000
@@ -56,11 +56,16 @@
 #define NyLPC_cStr_finalize(i)
 
 /**
-文字をバッファへ追加します。
-*/
+ * 文字をバッファへ追加します。
+ * @return
+ * TRUE 追加に成功;FALSE 追加に失敗
+ */
 NyLPC_TBool NyLPC_cStr_put(NyLPC_TcStr_t* i_inst,NyLPC_TChar i_c);
+
 /**
  * 残容量を返します。
+ * @return
+ * バイト単位のバッファの残り容量
  */
 #define NyLPC_cStr_capacity(i_inst) ((i_inst)->s-(i_inst)->l)
 
@@ -69,8 +74,8 @@
 */
 #define NyLPC_cStr_len(i_inst) ((i_inst)->l)
 /**
-文字列ポインタを返します。
-*/
+ * 文字列ポインタを返します。
+　*/
 #define NyLPC_cStr_str(i_inst) ((NyLPC_TChar*)((i_inst)->buf))
 /**
 文字列長さをリセットします。
@@ -91,4 +96,4 @@
 }
 #endif /* __cplusplus */
 
-#endif /* NYLPC_CSTR_H_ */
\ No newline at end of file
+#endif /* NYLPC_CSTR_H_ */