documentation bits in comments, no code changes
authorvda <vda@69ca8d6d-28ef-0310-b511-8ec308f3f277>
Tue, 25 Sep 2007 18:35:28 +0000 (18:35 +0000)
committervda <vda@69ca8d6d-28ef-0310-b511-8ec308f3f277>
Tue, 25 Sep 2007 18:35:28 +0000 (18:35 +0000)
git-svn-id: svn://busybox.net/trunk/busybox@20025 69ca8d6d-28ef-0310-b511-8ec308f3f277

editors/ed.c
include/libbb.h
libbb/lineedit.c
libbb/skip_whitespace.c

index f5b9c39..cd3836a 100644 (file)
@@ -82,7 +82,6 @@ static int bad_nums(int num1, int num2, const char *for_what)
 
 static char *skip_blank(const char *cp)
 {
-// NB: fix comment in skip_whitespace!
        while (isblank(*cp))
                cp++;
        return (char *)cp;
@@ -125,7 +124,6 @@ static void doCommands(void)
        smallint have1, have2;
 
        while (TRUE) {
-// NB: fix comment in lineedit.c!
                /* Returns:
                 * -1 on read errors or EOF, or on bare Ctrl-D.
                 * 0  on ctrl-C,
index 25b2e44..407b723 100644 (file)
@@ -892,6 +892,12 @@ enum {
        FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
 };
 line_input_t *new_line_input_t(int flags);
+/* Returns:
+ * -1 on read errors or EOF, or on bare Ctrl-D.
+ * 0  on ctrl-C,
+ * >0 length of input string, including terminating '\n'
+ * [is this true? stores "" in 'command' if return value is 0 or -1]
+ */
 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
 #else
 int read_line_input(const char* prompt, char* command, int maxsize);
index 62f8949..a018a53 100644 (file)
@@ -1253,6 +1253,11 @@ static void win_changed(int nsig)
 #undef CTRL
 #define CTRL(a) ((a) & ~0x40)
 
+/* Returns:
+ * -1 on read errors or EOF, or on bare Ctrl-D.
+ * 0  on ctrl-C,
+ * >0 length of input string, including terminating '\n'
+ */
 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *st)
 {
        int lastWasTab = FALSE;
index bdfb97d..87b5f23 100644 (file)
@@ -11,7 +11,7 @@
 
 char *skip_whitespace(const char *s)
 {
-       /* NB: isspace('0') returns 0 */
+       /* NB: isspace('\0') returns 0 */
        while (isspace(*s)) ++s;
 
        return (char *) s;