From 180ec65687f7aafb4f4b1948a5543628d553802f Mon Sep 17 00:00:00 2001 From: Manolo Gouy Date: Wed, 1 Dec 2010 17:38:29 +0000 Subject: Doxygen changes to indicate what to #include for functions documented in modules. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7932 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl.H | 22 +++++++++++++--------- FL/mac.H | 5 ++--- src/Fl_Color_Chooser.cxx | 2 ++ src/fl_ask.cxx | 11 ++++++++++- src/fl_file_dir.cxx | 8 ++++++-- src/fl_open_uri.cxx | 3 +++ 6 files changed, 36 insertions(+), 15 deletions(-) diff --git a/FL/Fl.H b/FL/Fl.H index ad32ccc7c..24778af49 100644 --- a/FL/Fl.H +++ b/FL/Fl.H @@ -54,7 +54,7 @@ struct Fl_Label; /** \defgroup callback_functions Callback function typedefs - \brief Typedefs for callback or handler functions passed as function parameters. + \brief Typedefs defined in for callback or handler functions passed as function parameters. FLTK uses callback functions as parameters for some function calls, e.g. to set up global event handlers (Fl::add_handler()), to add a timeout handler @@ -357,6 +357,7 @@ public: be messed up, but the user can probably keep working - all X protocol errors call this, for example. The default implementation returns after displaying the message. + \note \#include */ static void (*warning)(const char*, ...); /** @@ -371,6 +372,7 @@ public: Fl::error() means there is a recoverable error such as the inability to read an image file. The default implementation returns after displaying the message. + \note \#include */ static void (*error)(const char*, ...); /** @@ -387,12 +389,13 @@ public: version may be able to use longjmp or an exception to continue, as long as it does not call FLTK again. The default implementation exits with status 1 after displaying the message. + \note \#include */ static void (*fatal)(const char*, ...); /** @} */ /** \defgroup fl_windows Windows handling functions - Windows and standard dialogs handling + \brief Windows and standard dialogs handling defined in @{ */ static Fl_Window* first_window(); static void first_window(Fl_Window*); @@ -438,7 +441,7 @@ public: /** @} */ /** \defgroup fl_events Events handling functions - Fl class events handling API + Fl class events handling API defined in @{ */ // event information: @@ -675,7 +678,7 @@ public: /** @} */ /** \defgroup fl_clipboard Selection & Clipboard functions - fl global copy/cut/paste functions + FLTK global copy/cut/paste functions defined in @{ */ // cut/paste: /** @@ -709,7 +712,7 @@ public: static void paste(Fl_Widget &receiver); /** @} */ /** \defgroup fl_screen Screen functions - fl global screen functions + fl global screen functions defined in @{ */ // screen size: /** Returns the origin of the current screen, where 0 indicates the left side of the screen. */ @@ -737,7 +740,8 @@ public: /** @} */ /** \defgroup fl_attributes Color & Font functions - fl global color, font functions + fl global color, font functions. + These functions are declared in or . @{ */ // color map: @@ -921,7 +925,7 @@ public: */ static int dnd_text_ops() { return dnd_text_ops_; } /** \defgroup fl_multithread Multithreading support functions - fl multithreading support functions + fl multithreading support functions defined in @{ */ // Multithreading support: @@ -941,7 +945,7 @@ public: /** \defgroup fl_del_widget Safe widget deletion support functions - These functions support deletion of widgets inside callbacks. + These functions,defined in , support deletion of widgets inside callbacks. Fl::delete_widget() should be called when deleting widgets or complete widget trees (Fl_Group, Fl_Window, ...) inside @@ -1106,7 +1110,7 @@ public: }; /** \defgroup fl_unicode Unicode and UTF-8 functions - fl global Unicode and UTF-8 handling functions + fl global Unicode and UTF-8 handling functions defined in @{ */ /** @} */ diff --git a/FL/mac.H b/FL/mac.H index 3ff8ca702..b209df4e3 100644 --- a/FL/mac.H +++ b/FL/mac.H @@ -168,16 +168,15 @@ extern FL_EXPORT int fl_parse_color(const char* p, uchar& r, uchar& g, uchar& b) #endif // FL_DOXYGEN /** \defgroup group_macosx Mac OS X-specific functions + Mac OS X-specific functions defined in or @{ */ /** @brief Register a function called for each file dropped onto an application icon - * \note \#include */ extern void fl_open_callback(void (*cb)(const char *)); /** * \brief Attaches a callback to the "About myprog" item of the system application menu. - * \note \#include * * \param cb a callback that will be called by "About myprog" menu item * with NULL 1st argument. @@ -186,7 +185,7 @@ extern void fl_open_callback(void (*cb)(const char *)); */ extern void fl_mac_set_about( Fl_Callback *cb, void *user_data, int shortcut = 0); -/** The version number of the running Mac OS X (e.g., 0x1064 for 10.6.4) +/** \brief The version number of the running Mac OS X (e.g., 0x1064 for 10.6.4) */ extern int fl_mac_os_version; diff --git a/src/Fl_Color_Chooser.cxx b/src/Fl_Color_Chooser.cxx index 0c1cdbe3f..b009b01df 100644 --- a/src/Fl_Color_Chooser.cxx +++ b/src/Fl_Color_Chooser.cxx @@ -560,6 +560,7 @@ static void cc_cancel_cb (Fl_Widget *o, void *p) { @{ */ /** \brief Pops up a window to let the user pick an arbitrary RGB color. + \note \#include \image html fl_color_chooser.jpg \image latex fl_color_chooser.eps "fl_color_chooser" width=8cm \param[in] name Title label for the window @@ -602,6 +603,7 @@ int fl_color_chooser(const char* name, double& r, double& g, double& b, int cmod /** \brief Pops up a window to let the user pick an arbitrary RGB color. + \note \#include \image html fl_color_chooser.jpg \image latex fl_color_chooser.eps "fl_color_chooser" width=8cm \param[in] name Title label for the window diff --git a/src/fl_ask.cxx b/src/fl_ask.cxx index 962aebeb3..7e11fb944 100644 --- a/src/fl_ask.cxx +++ b/src/fl_ask.cxx @@ -261,6 +261,7 @@ const char* fl_close= "Close"; ///< string pointer used in common dialogs, you /** Emits a system beep message. + \note \#include */ void fl_beep(int type) { #ifdef WIN32 @@ -330,6 +331,8 @@ void fl_beep(int type) { \note Common dialog boxes are application modal. No more than one common dialog box can be open at any time. Requests for additional dialog boxes are ignored. + \note \#include + \param[in] fmt can be used as an sprintf-like format and variables for the message text */ @@ -352,6 +355,7 @@ void fl_message(const char *fmt, ...) { \note Common dialog boxes are application modal. No more than one common dialog box can be open at any time. Requests for additional dialog boxes are ignored. + \note \#include \param[in] fmt can be used as an sprintf-like format and variables for the message text */ @@ -374,6 +378,7 @@ void fl_alert(const char *fmt, ...) { \note Common dialog boxes are application modal. No more than one common dialog box can be open at any time. Requests for additional dialog boxes are ignored. + \note \#include \param[in] fmt can be used as an sprintf-like format and variables for the message text \retval 0 if the no button is selected or another dialog box is still open @@ -398,7 +403,8 @@ int fl_ask(const char *fmt, ...) { this dialog features up to 3 customizable choice buttons \note Common dialog boxes are application modal. No more than one common dialog box - can be open at any time. Requests for additional dialog boxes are ignored. + can be open at any time. Requests for additional dialog boxes are ignored. + \note \#include \param[in] fmt can be used as an sprintf-like format and variables for the message text \param[in] b0 text label of button 0 @@ -424,6 +430,7 @@ int fl_choice(const char*fmt,const char *b0,const char *b1,const char *b2,...){ /** Gets the Fl_Box icon container of the current default dialog used in many common dialogs like fl_message(), fl_alert(), fl_ask(), fl_choice(), fl_input(), fl_password() + \note \#include */ Fl_Widget *fl_message_icon() {makeform(); return icon;} @@ -446,6 +453,7 @@ static const char* input_innards(const char* fmt, va_list ap, \note Common dialog boxes are application modal. No more than one common dialog box can be open at any time. Requests for additional dialog boxes are ignored. + \note \#include \param[in] fmt can be used as an sprintf-like format and variables for the message text \param[in] defstr defines the default returned string if no text is entered @@ -471,6 +479,7 @@ const char* fl_input(const char *fmt, const char *defstr, ...) { \note Common dialog boxes are application modal. No more than one common dialog box can be open at any time. Requests for additional dialog boxes are ignored. + \note \#include \param[in] fmt can be used as an sprintf-like format and variables for the message text \param[in] defstr defines the default returned string if no text is entered diff --git a/src/fl_file_dir.cxx b/src/fl_file_dir.cxx index aa9a77f0b..19156e4dd 100644 --- a/src/fl_file_dir.cxx +++ b/src/fl_file_dir.cxx @@ -45,16 +45,18 @@ static void callback(Fl_File_Chooser *, void*) { /** \addtogroup group_comdlg @{ */ -/** \relatesalso Fl_File_Chooser +/** \relates Fl_File_Chooser Set the file chooser callback + \note \#include */ void fl_file_chooser_callback(void (*cb)(const char*)) { current_callback = cb; } -/** \relatesalso Fl_File_Chooser +/** \relates Fl_File_Chooser Set the "OK" button label + \note \#include */ void fl_file_chooser_ok_label(const char *l) { if (l) current_label = l; @@ -63,6 +65,7 @@ void fl_file_chooser_ok_label(const char *l) { /** \relates Fl_File_Chooser Shows a file chooser dialog and gets a filename. + \note \#include \image html Fl_File_Chooser.jpg \image latex Fl_File_Chooser.eps "Fl_File_Chooser" width=12cm \param[in] message text in title bar @@ -148,6 +151,7 @@ fl_file_chooser(const char *message, // I - Message in titlebar /** \relates Fl_File_Chooser Shows a file chooser dialog and gets a directory. + \note \#include \param[in] message title bar text \param[in] fname initial/default directory name \param[in] relative 0 for absolute path return, relative otherwise diff --git a/src/fl_open_uri.cxx b/src/fl_open_uri.cxx index 141744ea9..2277d2ed1 100644 --- a/src/fl_open_uri.cxx +++ b/src/fl_open_uri.cxx @@ -57,6 +57,8 @@ static char *path_find(const char *program, char *filename, int filesize); static int run_program(const char *program, char **argv, char *msg, int msglen); #endif // !WIN32 +/** \addtogroup filenames + @{ */ /** * Opens the specified Uniform Resource Identifier (URI). @@ -239,6 +241,7 @@ fl_open_uri(const char *uri, char *msg, int msglen) { #endif // WIN32 } +/** @} */ #if !defined(WIN32) && !defined(__APPLE__) // Find a program in the path... -- cgit v1.2.3