add some documentation for the urj_parse_* funcs

git-svn-id: https://urjtag.svn.sourceforge.net/svnroot/urjtag/trunk@1875 b68d4a1b-bc3d-0410-92ed-d4ac073336b7

urjtag/ChangeLog

@@ -2,6 +2,8 @@
 
   * src/bfin/bfin-part.c (_bfin_part_init): Add missing "void" to param list.
 
+  * include/urjtag/parse.h: Document the various stream functions.
+
 2011-02-17  Mike Frysinger  <vapier@gentoo.org>
 
   * data/analog/bf548/STEPPINGS: Add bf54x-0.4 support.

urjtag/include/urjtag/parse.h

@@ -30,20 +30,28 @@
 #include "types.h"
 
 /**
+ * Take care of tokenizing the line before sending to urj_cmd_run().
+ *
  * @return
  *      URJ_STATUS_OK on success
  *      URJ_STATUS_ERROR on error
  *      URJ_STATUS_QUIT on quit command
  */
 int urj_parse_line (urj_chain_t *chain, char *line);
+
 /**
+ * Run each line in the specified stream through urj_parse_line().
+ *
  * @return
  *      URJ_STATUS_OK on success
  *      URJ_STATUS_ERROR on error
  *      URJ_STATUS_QUIT on quit command
  */
 int urj_parse_stream (urj_log_level_t ll, urj_chain_t *chain, FILE *f);
+
 /**
+ * Open the specified file and run through urj_parse_stream().
+ *
  * @return
  *      URJ_STATUS_OK on success
  *      URJ_STATUS_ERROR on error