Doxygen documentation for text.h, SFont.h, setup.h, realpath.h, readline.h, palette.h, keyboard.h, io.h, input.h, hotkeys.h, helpfile.h, errors.h; and a basic description for all other headers.

Removed 2 unused function prototypes (They escaped translation)
In each C file, added a #include of its own header, to help doxygen generate a more complete documentation for the C files (and also double-check function prototypes)

All these changes don't change the generated executable, it's still beta 99.0.

git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@752 416bcca6-2ee7-4201-b75f-2eb2f807beb1

setup.h

@@ -21,7 +21,36 @@
     write to the Free Software Foundation, Inc.,
     59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
+
+//////////////////////////////////////////////////////////////////////////////
+///@file setup.h
+/// Functions that determine where grafx2 is running, finds its data, and
+/// reads and writes configuration files.
+//////////////////////////////////////////////////////////////////////////////
+
+///
+/// Determine which directory contains the executable.
+/// - IN: Main's argv[0], some platforms need it, some don't.
+/// - OUT: Write into program_dir. Trailing / or \ is kept.
+/// Note : in fact this is only used to check for the datafiles and fonts in this same directory.
 void Set_program_directory(const char * argv0,char * program_dir);
+
+///
+/// Determine which directory contains the read-only data.
+/// IN: The directory containing the executable
+/// OUT: Write into data_dir. Trailing / or \ is kept.
 void Set_data_directory(const char * program_dir, char * data_dir);
+
+///
+/// Determine which directory should store the user's configuration.
+/// For most Unix and Windows platforms:
+/// If a config file already exists in program_dir, it will return it in priority
+/// (Useful for development, and possibly for upgrading from DOS version)
+/// If the standard directory doesn't exist yet, this function will attempt 
+/// to create it ($(HOME)/.grafx2, or %APPDATA%\\GrafX2)
+/// If it cannot be created, this function will return the executable's
+/// own directory.
+/// IN: The directory containing the executable
+/// OUT: Write into config_dir. Trailing / or \ is kept.
 void Set_config_directory(const char * program_dir, char * config_dir);