From 8df7a9cbbea45d327f88e26c4dfc5c869ad4d340 Mon Sep 17 00:00:00 2001 From: Mike Frysinger Date: Fri, 18 Feb 2011 19:25:42 +0000 Subject: [PATCH] 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 ++ urjtag/include/urjtag/parse.h | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/urjtag/ChangeLog b/urjtag/ChangeLog index cc377409..da62d4f3 100644 --- a/urjtag/ChangeLog +++ b/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 * data/analog/bf548/STEPPINGS: Add bf54x-0.4 support. diff --git a/urjtag/include/urjtag/parse.h b/urjtag/include/urjtag/parse.h index e0506a9b..3b5bb88e 100644 --- a/urjtag/include/urjtag/parse.h +++ b/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