Documentation updates. Fixes a few formating bugs, adds various minor missing api documentation, fixes a few typos. Also fixes a few tiny code issues, mostly missing consts, etc

darcs-hash:20060617130708-ac50b-cc2ec5aa3e4bfb8e28d7b86441bfb4661f1dd7e7.gz

1 files changed, 21 insertions, 0 deletions

diff --git a/fish_pager.c b/fish_pager.c
index c3053297..e947a362 100644
--- a/fish_pager.c
+++ b/fish_pager.c
@@ -97,13 +97,34 @@ static wchar_t *hightlight_var[] =
 static string_buffer_t out_buff;
 static FILE *out_file;
 
+/**
+   Data structure describing one or a group of related completions
+ */
 typedef struct 
 {
+	/**
+	   The list of all completin strings this entry applies to
+	*/
 	array_list_t *comp;
+	/**
+	   The description
+	*/
 	wchar_t *desc;
+	/**
+	   On-screen width of the completion string
+	*/
 	int comp_width;	
+	/**
+	   On-screen width of the description information
+	*/
 	int desc_width;	
+	/**
+	   Preffered total width
+	*/
 	int pref_width;
+	/**
+	   Minimum acceptable width
+	*/
 	int min_width;
 }
 	comp_t;