added some comments describing alpha functions

diff --git a/include/comedilib.h b/include/comedilib.h
index 580cc9f77c968e5521e58beb43a7b971b75e6a4e..4eea689038a586bb382bce9caa97ae51ee9376db 100644 (file)
--- a/include/comedilib.h
+++ b/include/comedilib.h
@@ -150,11 +150,17 @@ enum comedi_oor_behavior {
 
 enum comedi_oor_behavior comedi_set_global_oor_behavior(enum comedi_oor_behavior behavior);
 
+// changes size (in bytes) of comedi's preallocated buffer, returns size of new buffer
 int comedi_buf_resize(comedi_t *it, unsigned int subdev, unsigned int size);
+// changes maximum size of preallocated buffer, requires root priviledge, returns new max size
 int comedi_buf_resize_max(comedi_t *it, unsigned int subdev, unsigned int max_size);
+// returns size (in bytes) of comedi's preallocated buffer
 int comedi_buf_size(comedi_t *it, unsigned int subdev);
+// returns number of bytes in buffer waiting to be read by user
 int comedi_buf_contents(comedi_t *it, unsigned int subdev);
+// marks 'bytes' number of bytes in buffer as read by user, returns number of bytes left to be read
 int comedi_buf_mark_read(comedi_t *it, unsigned int subdev, unsigned int bytes);
+// returns offset in bytes from beginning of buffer for first unread data point in buffer
 int comedi_buf_offset(comedi_t *it, unsigned int subdev);
 
 #ifdef __cplusplus