summaryrefslogtreecommitdiff
path: root/src/filename_list.cxx
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2010-01-01 18:30:49 +0000
committerGreg Ercolano <erco@seriss.com>2010-01-01 18:30:49 +0000
commitb08153975c2b4faa052ab678b9d38f156a32b9e3 (patch)
treed8c4bcb7aaed8feb1dc23dcce33e91983c404145 /src/filename_list.cxx
parent2164880821959e68fbf55061eba274ca176e9b69 (diff)
Updated filename.H function docs with indication of #include <FL/filename.H>
and in several cases, code examples. Solves issue raised on fltk.general (12/30/09) by Alvin. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6986 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/filename_list.cxx')
-rw-r--r--src/filename_list.cxx6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/filename_list.cxx b/src/filename_list.cxx
index e32375557..f8cbe9eb1 100644
--- a/src/filename_list.cxx
+++ b/src/filename_list.cxx
@@ -58,6 +58,12 @@ int fl_casealphasort(struct dirent **a, struct dirent **b) {
The number of entries is given as a return value.
If there is an error reading the directory a number less than zero is returned,
and errno has the reason; errno does not work under WIN32.
+
+ \b Include:
+ \code
+ #include <FL/filename.H>
+ \endcode
+
\param[in] d the name of the directory to list. It does not matter if it has a trailing slash.
\param[out] list table containing the resulting directory listing
\param[in] sort sorting functor: