Skip to content

Commit

Permalink
Some Doxygen doc fine tuning.
Browse files Browse the repository at this point in the history
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8345 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
  • Loading branch information
Manolo Gouy authored and Manolo Gouy committed Jan 31, 2011
1 parent caef04e commit 7531d0e
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions src/fl_file_dir.cxx
Expand Up @@ -45,25 +45,27 @@ static void callback(Fl_File_Chooser *, void*) {
/** \addtogroup group_comdlg
@{ */

/** \relates Fl_File_Chooser
/**
Set the file chooser callback
\note \#include <FL/Fl_File_Chooser.H>
\relates Fl_File_Chooser
*/
void fl_file_chooser_callback(void (*cb)(const char*)) {
current_callback = cb;
}


/** \relates Fl_File_Chooser
/**
Set the "OK" button label
\note \#include <FL/Fl_File_Chooser.H>
\relates Fl_File_Chooser
*/
void fl_file_chooser_ok_label(const char *l) {
if (l) current_label = l;
else current_label = fl_ok;
}

/** \relates Fl_File_Chooser
/**
Shows a file chooser dialog and gets a filename.
\note \#include <FL/Fl_File_Chooser.H>
\image html Fl_File_Chooser.jpg
Expand All @@ -74,6 +76,7 @@ void fl_file_chooser_ok_label(const char *l) {
\param[in] relative 0 for absolute path name, relative path name otherwise
\return the user selected filename, in absolute or relative format
or NULL if user cancels
\relates Fl_File_Chooser
*/
char * // O - Filename or NULL
fl_file_chooser(const char *message, // I - Message in titlebar
Expand Down Expand Up @@ -149,15 +152,14 @@ fl_file_chooser(const char *message, // I - Message in titlebar
else return 0;
}

/** \relates Fl_File_Chooser
Shows a file chooser dialog and gets a directory.
/** Shows a file chooser dialog and gets a directory.
\note \#include <FL/Fl_File_Chooser.H>
\param[in] message title bar text
\param[in] fname initial/default directory name
\param[in] relative 0 for absolute path return, relative otherwise
\return the directory path string chosen by the user or NULL if user cancels
\relates Fl_File_Chooser
*/

char * // O - Directory or NULL
fl_dir_chooser(const char *message, // I - Message for titlebar
const char *fname, // I - Initial directory name
Expand Down

0 comments on commit 7531d0e

Please sign in to comment.