From 9c789b0e69d7d2e0502965f48131085ce76488d3 Mon Sep 17 00:00:00 2001 From: engelsman Date: Tue, 30 Sep 2008 22:22:49 +0000 Subject: doxygen comments for undocumented features of Fl_File_Chooser - needed to use new doxygen comment feature in fluid to provide comments for the various static const char* member variables (eg add_favorites_label). I had not been able to work out how to add the comments "out-of-code" in src/Fl_File_Chooser2.cxx without getting unpredictable end-results. - needed to add doxygen comments for newButton and previewButton to the "out-of-code" comments in src/Fl_File_Chooser2.cxx because the new doxygen comment feature in fluid doesn't extend to widget member variables :-( - added some missing "out-of-code" comments about customization/copying. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6358 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- src/Fl_File_Chooser2.cxx | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'src/Fl_File_Chooser2.cxx') diff --git a/src/Fl_File_Chooser2.cxx b/src/Fl_File_Chooser2.cxx index 0484b5f3d..02dfdc665 100644 --- a/src/Fl_File_Chooser2.cxx +++ b/src/Fl_File_Chooser2.cxx @@ -100,8 +100,13 @@ fl_numericsort -

The sort member specifies the sort function that is - used when loading the contents of a directory. +

The Fl_File_Chooser::sort member specifies the sort function that is + used when loading the contents of a directory and can be customized + at run-time. +

The Fl_File_Chooser class also exports the Fl_File_Chooser::newButton + and Fl_File_Chooser::previewButton widgets so that application developers + can control their appearance and use. For more complex customization, + consider copying the FLTK file chooser code and changing it accordingly. */ /** \fn Fl_File_Chooser::Fl_File_Chooser(const char *pathname, const char *pattern, int type, const char *title) @@ -145,6 +150,16 @@ Fl_File_Chooser window. */ +/** \var Fl_File_Chooser::newButton + The "new directory" button is exported so that application developers + can control the appearance and use. +*/ + +/** \var Fl_File_Chooser::previewButton + The "preview" button is exported so that application developers can + control the appearance and use. +*/ + /** \fn Fl_File_Chooser::~Fl_File_Chooser() Destroys the widget and frees all memory used by it.*/ -- cgit v1.2.3