Large number of sourcecode comment edits, and some minor code polish

darcs-hash:20060620005010-ac50b-eaeae9a6242a37c1e34831e1a0b2ee2b4e7a012e.gz

1 files changed, 8 insertions, 0 deletions

diff --git a/highlight.c b/highlight.c
index f18c191d..25d58bea 100644
--- a/highlight.c
+++ b/highlight.c
@@ -33,6 +33,9 @@
 #include "halloc.h"
 #include "halloc_util.h"
 
+/**
+   Number of elements in the highlight_var array
+*/
 #define VAR_COUNT ( sizeof(highlight_var)/sizeof(wchar_t *) )
 
 static void highlight_universal_internal( wchar_t * buff, 
@@ -62,6 +65,11 @@ static wchar_t *highlight_var[] =
 }
 	;
 
+/**
+   Tests if the specified string is the prefix of any valid path in the system. 
+
+   \return zero it this is not a valid prefix, non-zero otherwise
+*/
 static int is_potential_path( const wchar_t *path )
 {
 	wchar_t *tilde, *unescaped;