diff options
| author | Greg Ercolano <erco@seriss.com> | 2010-01-01 18:30:49 +0000 |
|---|---|---|
| committer | Greg Ercolano <erco@seriss.com> | 2010-01-01 18:30:49 +0000 |
| commit | b08153975c2b4faa052ab678b9d38f156a32b9e3 (patch) | |
| tree | d8c4bcb7aaed8feb1dc23dcce33e91983c404145 /src/filename_isdir.cxx | |
| parent | 2164880821959e68fbf55061eba274ca176e9b69 (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_isdir.cxx')
| -rw-r--r-- | src/filename_isdir.cxx | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/filename_isdir.cxx b/src/filename_isdir.cxx index 2e4582266..90f1a3f4b 100644 --- a/src/filename_isdir.cxx +++ b/src/filename_isdir.cxx @@ -48,7 +48,13 @@ int _fl_filename_isdir_quick(const char* n) { } /** - Determines if a file exists and is a directory from its filename + Determines if a file exists and is a directory from its filename. + \code + #include <FL/filename.H> + [..] + fl_filename_isdir("/etc"); // returns non-zero + fl_filename_isdir("/etc/hosts"); // returns 0 + \endcode \param[in] n the filename to parse \return non zero if file exists and is a directory, zero otherwise */ |