Doxygen documentation

+ Added a new Module section named : File names and URI utility funtions
+ updated the pdf file adequately



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

1 files changed, 15 insertions, 6 deletions

diff --git a/FL/filename.H b/FL/filename.H
index 6bc5dda09..b7eadb118 100644
--- a/FL/filename.H
+++ b/FL/filename.H
@@ -30,9 +30,12 @@
 
 #  include "Fl_Export.H"
 
-#  define FL_PATH_MAX 256 /* all buffers are this length */
+/** \addtogroup filenames File names and URI utility funtions 
+    @{ */
 
-FL_EXPORT const char *fl_filename_name(const char *);
+#  define FL_PATH_MAX 256 ///< all path buffers should use this length
+/** Gets the file name from a path. \return a pointer to the char after the last slash, or to \a filename if there is none. */
+FL_EXPORT const char *fl_filename_name(const char * filename);
 FL_EXPORT const char *fl_filename_ext(const char *);
 FL_EXPORT char *fl_filename_setext(char *to, int tolen, const char *ext);
 FL_EXPORT int fl_filename_expand(char *to, int tolen, const char *from);
@@ -41,7 +44,7 @@ FL_EXPORT int fl_filename_relative(char *to, int tolen, const char *from);
 FL_EXPORT int fl_filename_match(const char *name, const char *pattern);
 FL_EXPORT int fl_filename_isdir(const char *name);
 
-#  ifdef __cplusplus
+#  if defined(__cplusplus) && !defined(FL_DOXYGEN)
 /*
  * Under WIN32, we include filename.H from numericsort.c; this should probably change...
  */
@@ -91,18 +94,20 @@ struct dirent {char d_name[1];};
 #    include <dirent.h>
 #  endif
 
-#  ifdef __cplusplus
+#  if defined (__cplusplus)
 extern "C" {
 #  endif /* __cplusplus */
 
+#  if !defined(FL_DOXYGEN)
 FL_EXPORT int fl_alphasort(struct dirent **, struct dirent **);
 FL_EXPORT int fl_casealphasort(struct dirent **, struct dirent **);
 FL_EXPORT int fl_casenumericsort(struct dirent **, struct dirent **);
 FL_EXPORT int fl_numericsort(struct dirent **, struct dirent **);
+#  endif
 
-typedef int (Fl_File_Sort_F)(struct dirent **, struct dirent **);
+  typedef int (Fl_File_Sort_F)(struct dirent **, struct dirent **); ///< File sorting function. \see fl_filename_list()
 
-#  ifdef __cplusplus
+#  if defined(__cplusplus)
 }
 
 /*
@@ -120,6 +125,7 @@ FL_EXPORT int fl_filename_list(const char *d, struct dirent ***l,
 FL_EXPORT int	fl_open_uri(const char *uri, char *msg = (char *)0,
 		            int msglen = 0);
 
+#    ifndef FL_DOXYGEN
 /*
  * _fl_filename_isdir_quick() is a private function that checks for a
  * trailing slash and assumes that the passed name is a directory if
@@ -128,6 +134,7 @@ FL_EXPORT int	fl_open_uri(const char *uri, char *msg = (char *)0,
  * outside of FLTK...
  */
 int _fl_filename_isdir_quick(const char *name);
+#    endif
 
 #  endif /* __cplusplus */
 
@@ -151,6 +158,8 @@ int _fl_filename_isdir_quick(const char *name);
 
 #endif /* FL_FILENAME_H */
 
+/** @} */
+
 /*
  * End of "$Id$".
  */