Skip to content

Commit

Permalink
Doxygen documentation
Browse files Browse the repository at this point in the history
 + 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
  • Loading branch information
fab672000 committed Sep 18, 2008
1 parent dcb87be commit 72ac772
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 19 deletions.
3 changes: 2 additions & 1 deletion FL/Fl_Text_Display.H
Expand Up @@ -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;
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion FL/Fl_Widget.H
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions documentation/Doxyfile
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions documentation/preface.dox
Expand Up @@ -97,9 +97,9 @@ HREF="license.html">Appendix J</A>.</B>

<H2>Copyrights and Trademarks</H2>

<P>FLTK is Copyright 1998-2006 by Bill Spitzak and others. Use and
<P>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 <A HREF="license.html#license">Appendix J</A>.</P>
License with 4 exceptions, located in <A HREF="license.html#license">Appendix J</A>.</P>

<P>UNIX is a registered trademark of the X Open Group, Inc.
Microsoft and Windows are registered trademarks of Microsoft
Expand Down
4 changes: 2 additions & 2 deletions src/Fl_Color_Chooser.cxx
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
23 changes: 12 additions & 11 deletions src/fl_file_dir.cxx
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 72ac772

Please sign in to comment.