Documented the fl_fopen() utility function.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9702 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

2 files changed, 13 insertions, 0 deletions

diff --git a/src/Fl_File_Chooser2.cxx b/src/Fl_File_Chooser2.cxx
index bed7b85b7..d192f636e 100644
--- a/src/Fl_File_Chooser2.cxx
+++ b/src/Fl_File_Chooser2.cxx
@@ -26,6 +26,11 @@
   
   \image html Fl_File_Chooser.jpg 
   \image latex  Fl_File_Chooser.jpg "Fl_File_Chooser" width=12cm
+ 
+ The Fl_File_Chooser widget transmits UTF-8 encoded filenames to its user. It is
+ recommended to open files that may have non-ASCII names with the fl_fopen() utility 
+ function that handles these names in a cross-platform way (whereas the standard 
+ fopen() function fails on the MSWindows platform to open files with a non-ASCII name).
   
   The Fl_File_Chooser class also exports several static values
   that may be used to localize or customize the appearance of all file chooser
diff --git a/src/fl_utf8.cxx b/src/fl_utf8.cxx
index fe67f3954..3b2f9a553 100644
--- a/src/fl_utf8.cxx
+++ b/src/fl_utf8.cxx
@@ -541,6 +541,14 @@ int fl_open(const char* f, int oflags, ...)
 #endif
 }
 
+/** Cross-platform function to open files with a UTF-8 encoded name.
+ 
+ This function is especially useful under the MSWindows platform where the 
+ standard fopen() function fails with UTF-8 encoded non-ASCII filenames.
+ \param f  the UTF-8 encoded filename
+ \param mode  same as the second argument of the standard fopen() function
+ \return  a FILE pointer upon successful completion, or NULL in case of error.
+ */
 FILE *fl_fopen(const char* f, const char *mode)
 {
 #if  defined (WIN32) && !defined(__CYGWIN__)