summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorManolo Gouy <Manolo>2010-12-01 17:38:29 +0000
committerManolo Gouy <Manolo>2010-12-01 17:38:29 +0000
commit180ec65687f7aafb4f4b1948a5543628d553802f (patch)
tree5b0e7f8ab7da0aca17c6a9be777229106d716a28 /src
parent04ca835e3aa366d218fe5ffc0cd2da78c0b614f0 (diff)
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
Diffstat (limited to 'src')
-rw-r--r--src/Fl_Color_Chooser.cxx2
-rw-r--r--src/fl_ask.cxx11
-rw-r--r--src/fl_file_dir.cxx8
-rw-r--r--src/fl_open_uri.cxx3
4 files changed, 21 insertions, 3 deletions
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 <FL/Fl_Color_Chooser.H>
\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 <FL/Fl_Color_Chooser.H>
\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 <FL/fl_ask.H>
*/
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 <FL/fl_ask.H>
+
\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 <FL/fl_ask.H>
\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 <FL/fl_ask.H>
\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 <FL/fl_ask.H>
\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/fl_ask.H>
*/
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 <FL/fl_ask.H>
\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 <FL/fl_ask.H>
\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 <FL/Fl_File_Chooser.H>
*/
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 <FL/Fl_File_Chooser.H>
*/
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 <FL/Fl_File_Chooser.H>
\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 <FL/Fl_File_Chooser.H>
\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...