From 406bafecc640ad002e33f90d99e5338fb0d3e88c Mon Sep 17 00:00:00 2001
From: Manolo Gouy <Manolo>
Date: Fri, 19 Oct 2012 09:23:05 +0000
Subject: Documented the fl_fopen() utility function.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9702 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 src/fl_utf8.cxx | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/fl_utf8.cxx')

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__)
-- 
cgit v1.2.3