Fixes to api documentation, added .PHONY to makefile actions, made a few private functions static

darcs-hash:20060123204014-ac50b-b9d2a10c7f00945b5d9d244cb3b8c1489fe280de.gz

1 files changed, 12 insertions, 1 deletions

diff --git a/input_common.h b/input_common.h
index 20a1cd8f..bf8182dd 100644
--- a/input_common.h
+++ b/input_common.h
@@ -8,7 +8,7 @@ Header file for the low level input library
 
 #include <wchar.h>
 
-/*
+/**
   Use unencoded private-use keycodes for internal characters
 */
 #define INPUT_COMMON_RESERVED 0xe000
@@ -24,8 +24,14 @@ enum
 }
 	;
 
+/**
+   Init the library
+*/
 void input_common_init( int (*ih)() );
 
+/**
+   Free memory used by the library
+*/
 void input_common_destroy();
 
 /**
@@ -39,6 +45,11 @@ void input_common_destroy();
 */
 wchar_t input_common_readch( int timed );
 
+/**
+   Push a character or a readline function onto the stack of unread
+   characters that input_readch will return before actually reading from fd
+   0.
+*/
 void input_common_unreadch( wint_t ch );
 
 #endif