Add lots of new code comments.

darcs-hash:20080113164747-75c98-9d0cefd27be7aef7ba60772616d9da7e6bb52912.gz

1 files changed, 8 insertions, 4 deletions

diff --git a/screen.h b/screen.h
index 19b12f7f..0e2c798a 100644
--- a/screen.h
+++ b/screen.h
@@ -2,9 +2,13 @@
 
 	The screen library allows the interactive reader to write its
 	output to screen efficiently by keeping an inetrnal representation
-	of the current screen contents and trying to find the most
+	of the current screen contents and trying to find a reasonably
 	efficient way for transforming that to the desired screen content.
-*/
+
+	The current implementation is less smart than ncurses allows
+	and can not for example move blocks of text around to handle text
+	insertion.
+  */
 #ifndef FISH_SCREEN_H
 #define FISH_SCREEN_H
 
@@ -13,7 +17,7 @@
 */
 typedef struct
 {
-	/*
+	/**
 	  The internal representation of the desired screen contents.
 	*/
 	array_list_t desired;
@@ -35,7 +39,7 @@ typedef struct
 	*/
 	string_buffer_t actual_prompt;
 
-	/*
+	/**
 	  The actual width of the screen at the time of the last screen
 	  write.
 	*/