Changeset e87e18f in mainline for console/screenbuffer.c

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.

File:

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

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)
 {