Documented the fl_open() utility function.

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

1 files changed, 10 insertions, 0 deletions

diff --git a/src/fl_utf8.cxx b/src/fl_utf8.cxx
index 3b2f9a553..c76a4b01e 100644
--- a/src/fl_utf8.cxx
+++ b/src/fl_utf8.cxx
@@ -518,6 +518,15 @@ char *fl_getenv(const char* v)
 #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 open() function fails with UTF-8 encoded non-ASCII filenames.
+ \param f  the UTF-8 encoded filename
+ \param oflags  other arguments are as in the standard open() function
+ \return  a file descriptor upon successful completion, or -1 in case of error.
+ \sa fl_fopen().
+ */
 int fl_open(const char* f, int oflags, ...)
 {
 	int pmode;
@@ -548,6 +557,7 @@ int fl_open(const char* f, int oflags, ...)
  \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.
+ \sa fl_open().
  */
 FILE *fl_fopen(const char* f, const char *mode)
 {