summaryrefslogtreecommitdiff
path: root/src/filename_isdir.cxx
diff options
context:
space:
mode:
Diffstat (limited to 'src/filename_isdir.cxx')
-rw-r--r--src/filename_isdir.cxx8
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
*/