diff --git a/docs/doxygen/mainpages/platdetails.h b/docs/doxygen/mainpages/platdetails.h index 6daca76a2d..53a5163f9b 100644 --- a/docs/doxygen/mainpages/platdetails.h +++ b/docs/doxygen/mainpages/platdetails.h @@ -43,14 +43,14 @@ on systems even with a much earlier version of GTK+. You will have to ensure that the application is launched with lazy symbol binding for that. In order to configure wxWidgets to compile wxGTK you will need use the -@c --with-gtk argument to the @c configure script. This is the default for many +@c \--with-gtk argument to the @c configure script. This is the default for many systems. GTK+ 1.2 can still be used, albeit discouraged. For that you can pass -@c --with-gtk=1 to the @c configure script. +@c \--with-gtk=1 to the @c configure script. Support for GTK+ 3 is available starting with wxWidgets 2.9.4, use @c configure -option @c --with-gtk=3 to enable it. +option @c \--with-gtk=3 to enable it. For further information, please see the files in @c docs/gtk in the distribution. diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h index 8c2a24594e..00fb5cfb7a 100644 --- a/docs/doxygen/mainpages/samples.h +++ b/docs/doxygen/mainpages/samples.h @@ -169,7 +169,7 @@ This sample shows how to use the common dialogs available from wxWidgets. These dialogs are described in detail in the @ref overview_cmndlg. In addition to the dialogs accessible from the sample menus, you can also run -it with a --progress=style command line option to show a +it with a \--progress=style command line option to show a wxProgressDialog with the given style (try 0 for the default style) on program startup, before the main window is shown. diff --git a/docs/doxygen/overviews/backwardcompatibility.h b/docs/doxygen/overviews/backwardcompatibility.h index 8a034e0695..b316cefe95 100644 --- a/docs/doxygen/overviews/backwardcompatibility.h +++ b/docs/doxygen/overviews/backwardcompatibility.h @@ -87,7 +87,7 @@ next earlier stable branch the default is 0, so @c WXWIN_COMPATIBILITY_2_4 = 0 for 2.8.x. Earlier than that, obsolete features are removed. These macros can be changed in @c setup.h. Or on UNIX-like systems you can set -them using the @c --disable-compat26 and @c --enable-compat24 options to +them using the @c \--disable-compat26 and @c \--enable-compat24 options to configure. They can be useful in two ways: diff --git a/docs/doxygen/overviews/container.h b/docs/doxygen/overviews/container.h index 931ef70671..fb76209eb5 100644 --- a/docs/doxygen/overviews/container.h +++ b/docs/doxygen/overviews/container.h @@ -96,8 +96,8 @@ uses its knowledge about wxString reference counting schema. To build wxWidgets with the standard containers you need to set wxUSE_STD_CONTAINERS option to 1 in @c wx/msw/setup.h for wxMSW builds or -specify @c --enable-std_containers option to configure (which is also -implicitly enabled by @c --enable-stl option) in Unix builds. +specify @c \--enable-std_containers option to configure (which is also +implicitly enabled by @c \--enable-stl option) in Unix builds. The standard container build is mostly, but not quite, compatible with the default one. Here are the most important differences: diff --git a/docs/doxygen/overviews/envvars.h b/docs/doxygen/overviews/envvars.h index 3e406b8ea1..b3604df420 100644 --- a/docs/doxygen/overviews/envvars.h +++ b/docs/doxygen/overviews/envvars.h @@ -22,7 +22,7 @@ wxWidgets programs. (Unix only.) Overrides installation prefix. Normally, the prefix is hard-coded and is the same as the value passed to @c configure via - the @c --prefix switch when compiling the library (typically + the @c \--prefix switch when compiling the library (typically @c /usr/local or @c /usr). You can set WXPREFIX if you are for example distributing a binary version of an application and you don't know in advance where it will be installed.} diff --git a/docs/doxygen/overviews/exceptions.h b/docs/doxygen/overviews/exceptions.h index e4f0e3395c..2e1467fca3 100644 --- a/docs/doxygen/overviews/exceptions.h +++ b/docs/doxygen/overviews/exceptions.h @@ -114,10 +114,10 @@ documentation of these functions for more details. To use any kind of exception support in the library you need to build it with @c wxUSE_EXCEPTIONS set to 1. It is turned on by default but you may wish to check @c include/wx/msw/setup.h file under Windows or run @c configure -with explicit @c --enable-exceptions argument under Unix. +with explicit @c \--enable-exceptions argument under Unix. On the other hand, if you do not plan to use exceptions, setting this -flag to 0 or using @c --disable-exceptions could result in a leaner and +flag to 0 or using @c \--disable-exceptions could result in a leaner and slightly faster library. As for any other library feature, there is a sample (@c except) diff --git a/docs/doxygen/overviews/nonenglish.h b/docs/doxygen/overviews/nonenglish.h index 7794ac6ac0..37d8c9c836 100644 --- a/docs/doxygen/overviews/nonenglish.h +++ b/docs/doxygen/overviews/nonenglish.h @@ -108,7 +108,7 @@ catalog, you may configure wxWidgets to use non-English msgids and translate to English using message catalogs: @li If you use the program @c xgettext to extract the strings from the source - code, specify the option --from-code=@. + code, specify the option \--from-code=@. @li Specify the source code language and charset as arguments to wxLocale::AddCatalog. For example: @code diff --git a/docs/doxygen/overviews/unicode.h b/docs/doxygen/overviews/unicode.h index c6c909416f..c79e754335 100644 --- a/docs/doxygen/overviews/unicode.h +++ b/docs/doxygen/overviews/unicode.h @@ -184,7 +184,7 @@ under all systems. Thus, under Microsoft Windows, UCS-2 (simplified version of UTF-16 without support for surrogate characters) is used as @c wchar_t is 2 bytes on this platform. Under Unix systems, including OS X, UCS-4 (also known as UTF-32) is used by default, however it is also possible to build -wxWidgets to use UTF-8 internally by passing @c --enable-utf8 option to +wxWidgets to use UTF-8 internally by passing @c \--enable-utf8 option to configure. The interface provided by wxString is the same independently of the format used @@ -208,7 +208,7 @@ of conversions (and also reduced memory usage of UTF-8 compared to UTF-32 for the European languages) can be important. If the environment in which your program is running is under your control -- as is quite often the case in such scenarios -- consider ensuring that the system always uses UTF-8 locale and -use @c --enable-utf8only configure option to disable support for the other +use @c \--enable-utf8only configure option to disable support for the other locales and consider all strings to be in UTF-8. This further reduces the code size and removes the need for conversions in more cases. @@ -216,7 +216,7 @@ size and removes the need for conversions in more cases. @subsection overview_unicode_settings Unicode Related Preprocessor Symbols @c wxUSE_UNICODE is defined as 1 now to indicate Unicode support. It can be -explicitly set to 0 in @c setup.h under MSW or you can use @c --disable-unicode +explicitly set to 0 in @c setup.h under MSW or you can use @c \--disable-unicode under Unix but doing this is strongly discouraged. By default, @c wxUSE_UNICODE_WCHAR is also defined as 1, however in UTF-8 build (described in the previous section), it is set to 0 and @c wxUSE_UNICODE_UTF8, which is diff --git a/docs/doxygen/overviews/unixprinting.h b/docs/doxygen/overviews/unixprinting.h index 151e57444c..98c317e205 100644 --- a/docs/doxygen/overviews/unixprinting.h +++ b/docs/doxygen/overviews/unixprinting.h @@ -20,7 +20,7 @@ using PostScript which never really matched the screen display. Since GTK+ 2.10, support for printing has been added to GTK+ itself and beginning with wxWidgets 2.9, GTK+ printing is used by default (i.e. unless ---without-gtkprint was explicitly used when configuring the library). +\--without-gtkprint was explicitly used when configuring the library). Support for GTK+ print is detected dynamically, i.e. during the run-time: if it is found, printing will be done through GTK+, otherwise the application will fall back to the old PostScript printing code. This allows the applications diff --git a/docs/doxygen/overviews/xrc.h b/docs/doxygen/overviews/xrc.h index 8f2fd55506..0580ec715e 100644 --- a/docs/doxygen/overviews/xrc.h +++ b/docs/doxygen/overviews/xrc.h @@ -255,19 +255,19 @@ To compile binary resource files, use the command-line @c wxrc utility. It takes one or more file parameters (the input XRC files) and the following switches and options: -@li -h (--help): Show a help message. -@li -v (--verbose): Show verbose logging information. -@li -c (--cpp-code): Write C++ source rather than a XRS file. -@li -e (--extra-cpp-code): If used together with -c, generates C++ header file +@li -h (\--help): Show a help message. +@li -v (\--verbose): Show verbose logging information. +@li -c (\--cpp-code): Write C++ source rather than a XRS file. +@li -e (\--extra-cpp-code): If used together with -c, generates C++ header file containing class definitions for the windows defined by the XRC file (see special subsection). -@li -u (--uncompressed): Do not compress XML files (C++ only). -@li -g (--gettext): Output underscore-wrapped strings that poEdit or gettext +@li -u (\--uncompressed): Do not compress XML files (C++ only). +@li -g (\--gettext): Output underscore-wrapped strings that poEdit or gettext can scan. Outputs to stdout, or a file if -o is used. -@li -n (--function) @: Specify C++ function name (use with -c). -@li -o (--output) @: Specify the output file, such as resource.xrs +@li -n (\--function) @: Specify C++ function name (use with -c). +@li -o (\--output) @: Specify the output file, such as resource.xrs or resource.cpp. -@li -l (--list-of-handlers) @: Output a list of necessary handlers +@li -l (\--list-of-handlers) @: Output a list of necessary handlers to this file. For example: diff --git a/interface/wx/app.h b/interface/wx/app.h index 1ec548eadb..fcaf21111a 100644 --- a/interface/wx/app.h +++ b/interface/wx/app.h @@ -311,7 +311,7 @@ public: virtual bool OnCmdLineError(wxCmdLineParser& parser); /** - Called when the help option (@c --help) was specified on the command line. + Called when the help option (@c \--help) was specified on the command line. The default behaviour is to show the program usage text and abort the program. Return @true to continue normal execution or @false to return diff --git a/interface/wx/hashmap.h b/interface/wx/hashmap.h index d0bf672e29..da3b1b4032 100644 --- a/interface/wx/hashmap.h +++ b/interface/wx/hashmap.h @@ -146,7 +146,7 @@ ++it ( and it++ ) to move to the next element, *it to access the element pointed to, it->first ( it->second ) to access the key ( value ) of the element pointed to. - Hash maps provide forward only iterators, this means that you can't use --it, + Hash maps provide forward only iterators, this means that you can't use \--it, it + 3, it1 - it2. diff --git a/interface/wx/hashset.h b/interface/wx/hashset.h index a7b19f5ae1..7d1743bc9e 100644 --- a/interface/wx/hashset.h +++ b/interface/wx/hashset.h @@ -131,7 +131,7 @@ An iterator is similar to a pointer, and so you can use the usual pointer operations: ++it ( and it++ ) to move to the next element, *it to access the element pointed to, *it to access the value of the element pointed to. - Hash sets provide forward only iterators, this means that you can't use --it, + Hash sets provide forward only iterators, this means that you can't use \--it, it + 3, it1 - it2. @library{wxbase} diff --git a/interface/wx/log.h b/interface/wx/log.h index c92daf9a7a..7b5dc8de73 100644 --- a/interface/wx/log.h +++ b/interface/wx/log.h @@ -1282,7 +1282,7 @@ void wxVLogInfo(const char* formatString, va_list argPtr); activated by calling wxLog::SetVerbose(). Notice that this is done automatically by wxWidgets, unless the standard - command line handling is overridden, if @c --verbose option is specified on + command line handling is overridden, if @c \--verbose option is specified on the program command line, so using these functions provides a simple way of having some diagnostic messages not shown by default but which can be easily shown by the user if needed. diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h index 4af72681fd..dd91ef5914 100644 --- a/interface/wx/textctrl.h +++ b/interface/wx/textctrl.h @@ -1613,7 +1613,7 @@ public: inheriting wxTextCtrl from @c std::streambuf in which case this class is not compiled in. You also must have @c wxUSE_STD_IOSTREAM option on (i.e. set to 1) in your - @c setup.h to be able to use it. Under Unix, specify @c --enable-std_iostreams + @c setup.h to be able to use it. Under Unix, specify @c \--enable-std_iostreams switch when running configure for this. Example of usage: