From 77cb18bfd4e1b6823b62abb06f15f3727fa855c9 Mon Sep 17 00:00:00 2001
From: Yuichi Nishiwaki <yuichi.nishiwaki@gmail.com>
Date: Sat, 14 Jun 2014 16:08:12 +0900
Subject: [PATCH] add commentary on pic_get_args

---
 src/vm.c | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/vm.c b/src/vm.c
index 6c89d8a8..1d79a89e 100644
--- a/src/vm.c
+++ b/src/vm.c
@@ -33,6 +33,27 @@ pic_get_proc(pic_state *pic)
   return pic_proc_ptr(v);
 }
 
+/**
+ * char type
+ * ---- ----
+ *  o   object
+ *  i   int
+ *  I   int with exactness
+ *  f   float
+ *  F   float with exactness
+ *  s   string object
+ *  z   c string
+ *  m   symbol
+ *  v   vector object
+ *  b   bytevector object
+ *  c   char
+ *  l   lambda object
+ *  p   port object
+ *
+ *  |  optional operator
+ *  *  variable length operator
+ */
+
 int
 pic_get_args(pic_state *pic, const char *format, ...)
 {