From 72ac77216d0331bdbe3fc2aba9bc6e3a7b384455 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Thu, 18 Sep 2008 10:34:22 +0000 Subject: Doxygen documentation + Added new \relatesalso dox command to attach fl_file_chooser(), fl_color_chooser() to their respective related classes + corrected copyright date and added lgpl with exceptions in preface + restored undocumented warnings, changed QUIET mode to yes, this way we get all warnings/errors and not the long verbose list treated files. Seems to be a bit faster to run too. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6297 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Text_Display.H | 3 ++- FL/Fl_Widget.H | 3 ++- documentation/Doxyfile | 4 ++-- documentation/preface.dox | 4 ++-- src/Fl_Color_Chooser.cxx | 4 ++-- src/fl_file_dir.cxx | 23 ++++++++++++----------- 6 files changed, 22 insertions(+), 19 deletions(-) diff --git a/FL/Fl_Text_Display.H b/FL/Fl_Text_Display.H index be2cd4f64..08286e79d 100644 --- a/FL/Fl_Text_Display.H +++ b/FL/Fl_Text_Display.H @@ -252,7 +252,7 @@ class FL_EXPORT Fl_Text_Display: public Fl_Group { int wrap_uses_character(int lineEndPos); int range_touches_selection(Fl_Text_Selection *sel, int rangeStart, int rangeEnd); - +#ifndef FL_DOXYGEN int damage_range1_start, damage_range1_end; int damage_range2_start, damage_range2_end; int mCursorPos; @@ -331,6 +331,7 @@ class FL_EXPORT Fl_Text_Display: public Fl_Group { // can implement line numbers without breaking binary compatibility. int mLineNumLeft, mLineNumWidth; /* Line number margin and width */ +#endif }; #endif diff --git a/FL/Fl_Widget.H b/FL/Fl_Widget.H index fbdd61524..6992cd905 100644 --- a/FL/Fl_Widget.H +++ b/FL/Fl_Widget.H @@ -692,7 +692,8 @@ public: */ int takesevents() const {return !(flags_&(INACTIVE|INVISIBLE|OUTPUT));} - /** Check if the widget value changed since the last callback. + /** + * Check if the widget value changed since the last callback. * "Changed" is a flag that is turned on when the user changes the value stored * in the widget. This is only used by subclasses of Fl_Widget that store values, * but is in the base class so it is easier to scan all the widgets in a panel diff --git a/documentation/Doxyfile b/documentation/Doxyfile index cf64577f9..4e02d8c1e 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -460,7 +460,7 @@ FILE_VERSION_FILTER = # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. -QUIET = NO +QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank @@ -472,7 +472,7 @@ WARNINGS = YES # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. -WARN_IF_UNDOCUMENTED = NO +WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some diff --git a/documentation/preface.dox b/documentation/preface.dox index 4f89a70d0..4845fe6ca 100644 --- a/documentation/preface.dox +++ b/documentation/preface.dox @@ -97,9 +97,9 @@ HREF="license.html">Appendix J.

Copyrights and Trademarks

-

FLTK is Copyright 1998-2006 by Bill Spitzak and others. Use and +

FLTK is Copyright 1998-2008 by Bill Spitzak and others. Use and distribution of FLTK is governed by the GNU Library General Public -License, located in Appendix J.

+License with 4 exceptions, located in Appendix J.

UNIX is a registered trademark of the X Open Group, Inc. Microsoft and Windows are registered trademarks of Microsoft diff --git a/src/Fl_Color_Chooser.cxx b/src/Fl_Color_Chooser.cxx index c57700025..dad84c312 100644 --- a/src/Fl_Color_Chooser.cxx +++ b/src/Fl_Color_Chooser.cxx @@ -535,7 +535,7 @@ extern const char* fl_cancel; color using dithering. */ -/** +/** \relatesalso Fl_Color_Chooser \ingroup fl_color_chooser_group \fn int fl_color_chooser(const char* name, double& r, double& g, double& b) \brief Pops up a window to let the user pick an arbitrary RGB color. @@ -577,7 +577,7 @@ int fl_color_chooser(const char* name, double& r, double& g, double& b) { return 0; } -/** +/** \relatesalso Fl_Color_Chooser \ingroup fl_color_chooser_group \fn int fl_color_chooser(const char* name, uchar& r, uchar& g, uchar& b) \brief Pops up a window to let the user pick an arbitrary RGB color. diff --git a/src/fl_file_dir.cxx b/src/fl_file_dir.cxx index b5fc90e4b..093a915cd 100644 --- a/src/fl_file_dir.cxx +++ b/src/fl_file_dir.cxx @@ -43,23 +43,25 @@ static void callback(Fl_File_Chooser *, void*) { } -// Set the file chooser callback +/** \relatesalso Fl_File_Chooser + Set the file chooser callback +*/ void fl_file_chooser_callback(void (*cb)(const char*)) { current_callback = cb; } -// Set the "OK" button label +/** \relatesalso Fl_File_Chooser + Set the "OK" button label +*/ void fl_file_chooser_ok_label(const char *l) { if (l) current_label = l; else current_label = fl_ok; } - -// -// 'fl_file_chooser()' - Show a file chooser dialog and get a filename. -// - +/** \relatesalso Fl_File_Chooser + Show a file chooser dialog and get a filename. +*/ char * // O - Filename or NULL fl_file_chooser(const char *message, // I - Message in titlebar const char *pat, // I - Filename pattern @@ -134,10 +136,9 @@ fl_file_chooser(const char *message, // I - Message in titlebar else return 0; } - -// -// 'fl_dir_chooser()' - Show a file chooser dialog and get a directory. -// +/** \relatesalso Fl_File_Chooser + Show a file chooser dialog and get a directory. +*/ char * // O - Directory or NULL fl_dir_chooser(const char *message, // I - Message for titlebar -- cgit v1.2.3