Changeset e87e18f in mainline

Timestamp:

2006-06-02T18:19:08Z (19 years ago)

Author:

Josef Cejka <malyzelenyhnus@…>

Branches:

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

Children:

d6cc453

Parents:

a9bd960c

Message:

Some doxygen comments added.

Location:

console

Files:

• console.c (modified) (4 diffs)
• screenbuffer.c (modified) (6 diffs)

console/console.c

@@ -48 +48 @@
 #define NAME "CONSOLE"
 
+/** Index of currently used virtual console.
+ */
 int active_console = 0;
 
+/** Information about framebuffer
+ */
 struct {
         int phone;              /**< Framebuffer phone */
@@ -56 +60 @@
 } fb_info;
 
+
 typedef struct {
-        keybuffer_t keybuffer;
-        FIFO_CREATE_STATIC(keyrequests, ipc_callid_t , MAX_KEYREQUESTS_BUFFERED);
-        int keyrequest_counter;
-        int client_phone;
-        int used;
-        screenbuffer_t screenbuffer;
+        keybuffer_t keybuffer;          /**< Buffer for incoming keys. */
+        FIFO_CREATE_STATIC(keyrequests, ipc_callid_t , MAX_KEYREQUESTS_BUFFERED);       /**< Buffer for unsatisfied request for keys. */
+        int keyrequest_counter;         /**< Number of requests in buffer. */
+        int client_phone;               /**< Phone to connected client. */
+        int used;                       /**< 1 if this virtual console is connected to some client.*/
+        screenbuffer_t screenbuffer;    /**< Screenbuffer for saving screen contents and related settings. */
 } connection_t;
 
-
-
-connection_t connections[CONSOLE_COUNT];
-keyfield_t *interbuffer = NULL;
-        
+connection_t connections[CONSOLE_COUNT];        /**< Array of data for virtual consoles */
+keyfield_t *interbuffer = NULL;                 /**< Pointer to memory shared with framebufer used for faster virt. console switching */
+
+
+/** Find unused virtual console.
+ *
+ */
 static int find_free_connection() 
 {
@@ -82 +89 @@
 }
 
-
+/** Find index of virtual console used by client with given phone.
+ *
+ */
 static int find_connection(int client_phone) 
 {
@@ -152 +161 @@
 
 
-/* Handler for keyboard */
+/** Handler for keyboard */
 static void keyboard_events(ipc_callid_t iid, ipc_call_t *icall)
 {

console/screenbuffer.c

@@ -47 +47 @@
 /** Initilize screenbuffer. Allocate space for screen content in accordance to given size.
  * @param scr           initialized screenbuffer
- * @param size_x        
- * @param size_y
+ * @param size_x        width in characters             
+ * @param size_y        height in characters
+ * @return pointer to screenbuffer (same as scr parameter) or NULL
  */
 screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y) 
@@ -66 +67 @@
 }
 
+/** Clear screenbuffer. 
+ * @param scr screenbuffer
+ */
 void screenbuffer_clear(screenbuffer_t *scr)
 {
@@ -80 +84 @@
 }
 
-/** Clear one buffer line
+/** Clear one buffer line.
  * @param scr
  * @param line One buffer line (not a screen line!)
@@ -94 +98 @@
 }
 
+/** Copy content buffer from screenbuffer to given memory.
+ * @param scr   source screenbuffer
+ * @param dest  destination
+ */
 void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest) 
 {
@@ -103 +111 @@
 }
 
+/** Set new cursor position in screenbuffer.
+ * @param scr
+ * @param x
+ * @param y
+ */
 void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y)
 {
@@ -109 +122 @@
 }
 
+/** Set new style.
+ * @param scr
+ * @param fg_color
+ * @param bg_color
+ */
 void screenbuffer_set_style(screenbuffer_t *scr, unsigned int fg_color, unsigned int bg_color)
 {