Changeset ed372da in mainline

Timestamp:

2009-12-05T16:03:12Z (15 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

371a012

Parents:

7e0cb78

Message:

Add some comments.

File:

• uspace/app/bdsh/input.c (modified) (6 diffs)

uspace/app/bdsh/input.c

@@ -51 +51 @@
 #define HISTORY_LEN 10
 
+/** Text input field. */
 typedef struct {
+        /** Buffer holding text currently being edited */
         wchar_t buffer[INPUT_MAX];
+        /** Screen coordinates of the top-left corner of the text field */
         int col0, row0;
+        /** Screen dimensions */
         int con_cols, con_rows;
+        /** Number of characters in @c buffer */
         int nc;
+        /** Caret position within buffer */
         int pos;
+        /** Selection mark position within buffer */
         int sel_start;
 
+        /** History (dynamically allocated strings) */
         char *history[1 + HISTORY_LEN];
+        /** Number of entries in @c history, not counting [0] */
         int hnum;
+        /** Current position in history */
         int hpos;
+        /** Exit flag */
         bool done;
 } tinput_t;
 
+/** Seek direction */
 typedef enum {
         seek_backward = -1,
@@ -196 +208 @@
         width = ti->col0 + ti->nc;
         rows = (width / ti->con_cols) + 1;
- 
+
         /* Update row0 if the screen scrolled. */
         if (ti->row0 + rows > ti->con_rows)
@@ -240 +252 @@
                 return;
         }
-  
+
         if (ti->pos == 0)
                 return;
@@ -461 +473 @@
 }
 
+/** Initialize text input field.
+ *
+ * Must be called before using the field. It clears the history.
+ */
 static void tinput_init(tinput_t *ti)
 {
@@ -468 +484 @@
 }
 
+/** Read in one line of input. */
 static char *tinput_read(tinput_t *ti)
 {
@@ -634 +651 @@
 }
 
-
 void get_input(cliuser_t *usr)
 {