diff options
author | Gregory Nutt <gnutt@nuttx.org> | 2013-09-30 17:43:44 -0600 |
---|---|---|
committer | Gregory Nutt <gnutt@nuttx.org> | 2013-09-30 17:43:44 -0600 |
commit | 7bbbe7e7b3159e2e021bae476099f40cf9cac3fb (patch) | |
tree | 44627342327e35a4fd7dc51afc4faf8bf844d75b /apps/include | |
parent | 58f64ee43dbc72698ba12973b8681cc170cf0f20 (diff) | |
download | nuttx-7bbbe7e7b3159e2e021bae476099f40cf9cac3fb.tar.gz nuttx-7bbbe7e7b3159e2e021bae476099f40cf9cac3fb.tar.bz2 nuttx-7bbbe7e7b3159e2e021bae476099f40cf9cac3fb.zip |
cosmetic update to comments
Diffstat (limited to 'apps/include')
-rw-r--r-- | apps/include/readline.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/apps/include/readline.h b/apps/include/readline.h index 463643534..a9c322b8c 100644 --- a/apps/include/readline.h +++ b/apps/include/readline.h @@ -98,11 +98,14 @@ ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream); /**************************************************************************** * Name: std_readline * - * std_readline is requivalent to readline except that it uses only stdin - * and stdout. + * readline() reads in at most one less than 'buflen' characters from + * 'stdin' and stores them into the buffer pointed to by 'buf'. + * Characters are echoed on 'stdout'. Reading stops after an EOF or a + * newline. If a newline is read, it is stored into the buffer. A null + * terminator is stored after the last character in the buffer. * * This version of realine assumes that we are reading and writing to - * a VT100 console. This will not work well if 'instream' or 'outstream' + * a VT100 console. This will not work well if 'stdin' or 'stdout' * corresponds to a raw byte steam. * * This function is inspired by the GNU readline but is an entirely @@ -111,8 +114,6 @@ ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream); * Input Parameters: * buf - The user allocated buffer to be filled. * buflen - the size of the buffer. - * instream - The stream to read characters from - * outstream - The stream to each characters to. * * Returned values: * On success, the (positive) number of bytes transferred is returned. |