From 9c789b0e69d7d2e0502965f48131085ce76488d3 Mon Sep 17 00:00:00 2001
From: engelsman <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
---
 FL/Fl_File_Chooser.H | 46 +++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 43 insertions(+), 3 deletions(-)

(limited to 'FL')

diff --git a/FL/Fl_File_Chooser.H b/FL/Fl_File_Chooser.H
index 1f0216fa1..026395eee 100644
--- a/FL/Fl_File_Chooser.H
+++ b/FL/Fl_File_Chooser.H
@@ -25,9 +25,6 @@
 //     http://www.fltk.org/str.php
 //
 
-/** \file
-   Fl_File_Chooser widget . */
-
 // generated by Fast Light User Interface Designer (fluid) version 1.0300
 
 #ifndef Fl_File_Chooser_H
@@ -164,19 +161,62 @@ public:
   const char *value(int f = 1); 
   void value(const char *filename); 
   int visible();
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *add_favorites_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *all_files_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *custom_filter_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *existing_file_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *favorites_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *filename_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *filesystems_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *manage_favorites_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *new_directory_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *new_directory_tooltip; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *preview_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *save_label; 
+  /**
+     [standard text may be customized at run-time]
+  */
   static const char *show_label; 
+  /**
+     the sort function that is used when loading
+     the contents of a directory.
+  */
   static Fl_File_Sort_F *sort; 
 private:
   Fl_Widget* ext_group; 
-- 
cgit v1.2.3