Huge API documentation cleanup

darcs-hash:20051024152625-ac50b-41503feb4ea8d428c5b30c159aaae0c8f7ae46a2.gz

1 files changed, 7 insertions, 6 deletions

diff --git a/expand.h b/expand.h
index d17899cf..3c650343 100644
--- a/expand.h
+++ b/expand.h
@@ -10,6 +10,9 @@
 */
 
 #ifndef FISH_EXPAND_H
+/**
+   Header guard
+*/
 #define FISH_EXPAND_H
 
 #include <wchar.h>
@@ -51,7 +54,7 @@
 
 #define DIRECTORIES_ONLY 32
 
-/*
+/**
   Use unencoded private-use keycodes for internal characters
 */
 #define EXPAND_RESERVED 0xf000
@@ -122,11 +125,9 @@ wchar_t *expand_one( wchar_t *in, int flag );
 /**
    Expand backslashed escapes and substitute them with their unescaped
    counterparts. Also optionally change the wildcards, the tilde
-   character and a few more into constants which are defined to be
-   outside of the valid character space, but still inside the valid
-   space for a wchar_t. This assumes that a wchar_t is at least 32
-   bits long AND that the characterset is UCS4 or some other 31-bit
-   character set.
+   character and a few more into constants which are defined in a
+   private use area of Unicode. This assumes wchar_t is a unicode
+   character.  character set.
 
    The result must be free()d. The original string is not modified. If
    an invalid sequence is specified, 0 is returned.