summaryrefslogtreecommitdiff
path: root/src/fl_open_uri.cxx
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2018-06-23 20:50:22 +0000
committerMatthias Melcher <fltk@matthiasm.com>2018-06-23 20:50:22 +0000
commitb8e97d7c28ad6f168e9314dab3c7651365b1c71c (patch)
treeaa722d1eb241aef345b6009fac807f060f82f7c6 /src/fl_open_uri.cxx
parentb1598dc70362f331da7a65f1e5ddece7c88299f3 (diff)
Doxygen only: fixed all block comments starting with an asterisk to space-only, fixed doxygen keywords prepended with @ to use a backward slash instead. No code was changed.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12970 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_open_uri.cxx')
-rw-r--r--src/fl_open_uri.cxx74
1 files changed, 37 insertions, 37 deletions
diff --git a/src/fl_open_uri.cxx b/src/fl_open_uri.cxx
index 57adfa452..6cde5d18b 100644
--- a/src/fl_open_uri.cxx
+++ b/src/fl_open_uri.cxx
@@ -33,45 +33,45 @@
#include "flstring.h"
/** \addtogroup filenames
- @{ */
+ \{ */
/**
- * Opens the specified Uniform Resource Identifier (URI).
- * Uses an operating-system dependent program or interface. For URIs
- * using the "ftp", "http", or "https" schemes, the system default web
- * browser is used to open the URI, while "mailto" and "news" URIs are
- * typically opened using the system default mail reader and "file" URIs
- * are opened using the file system navigator.
- *
- * On success, the (optional) msg buffer is filled with the command that
- * was run to open the URI; on Windows, this will always be "open uri".
- *
- * On failure, the msg buffer is filled with an English error message.
- *
- * \note
- * \b Platform \b Specific \b Issues: \b Windows \n
- * With "file:" based URIs on Windows, you may encounter issues with
- * anchors being ignored. Example: "file:///c:/some/index.html#anchor"
- * may open in the browser without the "#anchor" suffix. The behavior
- * seems to vary across different Windows versions. Workaround: open a link
- * to a separate html file that redirects to the desired "file:" URI.
- *
- * \b Example
- * \code
- * #include <FL/filename.H>
- * [..]
- * char errmsg[512];
- * if ( !fl_open_uri("http://google.com/", errmsg, sizeof(errmsg)) ) {
- * char warnmsg[768];
- * sprintf(warnmsg, "Error: %s", errmsg);
- * fl_alert(warnmsg);
- * }
- * \endcode
- *
- * @param uri The URI to open
- * @param msg Optional buffer which contains the command or error message
- * @param msglen Length of optional buffer
- * @return 1 on success, 0 on failure
+ Opens the specified Uniform Resource Identifier (URI).
+ Uses an operating-system dependent program or interface. For URIs
+ using the "ftp", "http", or "https" schemes, the system default web
+ browser is used to open the URI, while "mailto" and "news" URIs are
+ typically opened using the system default mail reader and "file" URIs
+ are opened using the file system navigator.
+
+ On success, the (optional) msg buffer is filled with the command that
+ was run to open the URI; on Windows, this will always be "open uri".
+
+ On failure, the msg buffer is filled with an English error message.
+
+ \note
+ \b Platform \b Specific \b Issues: \b Windows \n
+ With "file:" based URIs on Windows, you may encounter issues with
+ anchors being ignored. Example: "file:///c:/some/index.html#anchor"
+ may open in the browser without the "#anchor" suffix. The behavior
+ seems to vary across different Windows versions. Workaround: open a link
+ to a separate html file that redirects to the desired "file:" URI.
+
+ \b Example
+ \code
+ #include <FL/filename.H>
+ [..]
+ char errmsg[512];
+ if ( !fl_open_uri("http://google.com/", errmsg, sizeof(errmsg)) ) {
+ char warnmsg[768];
+ sprintf(warnmsg, "Error: %s", errmsg);
+ fl_alert(warnmsg);
+ }
+ \endcode
+
+ \param uri The URI to open
+ \param msg Optional buffer which contains the command or error message
+ \param msglen Length of optional buffer
+ \return 1 on success, 0 on failure
*/
int fl_open_uri(const char *uri, char *msg, int msglen) {
// Supported URI schemes...