From a406e2a7dcae0bf5bb36b73c2290cc247d188e66 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 28 Mar 2022 00:16:29 +0200 Subject: [PATCH 01/10] Quote paths using backslashes in Doxygen input Otherwise Doxygen interprets each path component as its command and complains about "unknown \msw command" in "build\msw" path, for example. --- docs/msw/gtk.md | 6 +++--- docs/msw/install.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/msw/gtk.md b/docs/msw/gtk.md index 631884bb18..99fa9dfec6 100644 --- a/docs/msw/gtk.md +++ b/docs/msw/gtk.md @@ -25,7 +25,7 @@ Regenerate required make/project files: 3. Download GTK+ for Windows and uncompress files in the directory without spaces in the name. We suppose later that GTK+/Win32 is -in the C:\gtk directory. +in the `C:\gtk` directory. http://ftp.gnome.org/pub/gnome/binaries/win32/gtk+/2.24/gtk+_2.24.10-1_win32.zip @@ -48,11 +48,11 @@ and library directory See http://msdn.microsoft.com/en-us/library/t9az1d21(v=vs.90).aspx -Open solution file in build\msw directory, select "GTK+ Debug" solution +Open solution file in `build\msw` directory, select "GTK+ Debug" solution configuration and build the solution. To be sure that everything is as expected you can build minimal sample. -GTK+ is linked to wxWidgets always as DLL, so C:\gtk\bin directory should be +GTK+ is linked to wxWidgets always as DLL, so `C:\gtk\bin` directory should be in %PATH% environment variable before application run. 4.2 You can also build using nmake: diff --git a/docs/msw/install.md b/docs/msw/install.md index ae47ebbdd5..515bb55a24 100644 --- a/docs/msw/install.md +++ b/docs/msw/install.md @@ -42,7 +42,7 @@ The following sections explain how to compile wxWidgets with each supported compiler, see the "Building Applications" section about the instructions for building your application using wxWidgets. -All makefiles and project are located in build\msw directory. +All makefiles and project are located in `build\msw` directory. Microsoft Visual C++ Compilation {#msw_build_msvs} ---------------------------------------------------------------- @@ -119,7 +119,7 @@ contributors. If the version is out of date, please [create an issue or pull req ### Special notes for Visual Studio 2010+ For Visual Studio 2010+ solutions it is possible to customize the build by -creating a `wx_local.props` file in the build\msw directory which is used, if it +creating a `wx_local.props` file in the `build\msw` directory which is used, if it exists, by the projects. The settings in that file override the default values for the properties such as wxCfg (corresponding to the CFG makefile variable described below) or wxVendor (corresponding to VENDOR). The typical way to @@ -239,7 +239,7 @@ executed from a DOS command line window (cmd.exe, *not* Bash sh.exe). make command without `setup_h` at the end to work around a bug in the current makefiles. -2. To verify your build, change the directory to samples\minimal and +2. To verify your build, change the directory to `samples\minimal` and run the same mingw32-make command (with the same parameters there), this should create a working minimal wxWidgets sample. From 7a269df2bfb185e5cfa401dc0d60da119af939d8 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 28 Mar 2022 00:17:26 +0200 Subject: [PATCH 02/10] Document all parameters of wxImage::Paste() As long as one parameter of a function is documented, all the other ones should be documented too, as otherwise Doxygen complains about it not being the case. --- interface/wx/image.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/interface/wx/image.h b/interface/wx/image.h index 46f339dd3b..a54fc868f9 100644 --- a/interface/wx/image.h +++ b/interface/wx/image.h @@ -823,6 +823,12 @@ public: Takes care of the mask colour and out of bounds problems. + @param image + The image containing the data to copy, must be valid. + @param x + The horizontal position of the position to copy the data to. + @param y + The vertical position of the position to copy the data to. @param alphaBlend This parameter (new in wx 3.1.5) determines whether the alpha values of the original image replace (default) or are composed with the From 19d477aabfb18e32654f2438e62aad11988fa6d7 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 28 Mar 2022 00:18:02 +0200 Subject: [PATCH 03/10] Consistently escape "@" in wxRichTextCtrl documentation The first occurrence of it was escaped, but the second one in each line was not, resulting in warnings about "unknown command @:". --- interface/wx/richtext/richtextprint.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/interface/wx/richtext/richtextprint.h b/interface/wx/richtext/richtextprint.h index bdbf60f8dd..44ecaaa920 100644 --- a/interface/wx/richtext/richtextprint.h +++ b/interface/wx/richtext/richtextprint.h @@ -44,11 +44,11 @@ enum wxRichTextPageLocation { You can specify the following keywords in header and footer text, which will be substituted for the actual values during printing and preview. - - @@DATE@: the current date. - - @@PAGESCNT@: the total number of pages. - - @@PAGENUM@: the current page number. - - @@TIME@: the current time. - - @@TITLE@: the title of the document, as passed to the wxRichTextPrinting or + - @@DATE@@: the current date. + - @@PAGESCNT@@: the total number of pages. + - @@PAGENUM@@: the current page number. + - @@TIME@@: the current time. + - @@TITLE@@: the title of the document, as passed to the wxRichTextPrinting or wxRichTextLayout constructor. @library{wxrichtext} From c6b5070083839565b9fa7e4e819082d2fb57cfb8 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 28 Mar 2022 00:18:39 +0200 Subject: [PATCH 04/10] Don't use non-existent "@this" command in wxUILocale docs Just use `this` instead. --- interface/wx/uilocale.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/interface/wx/uilocale.h b/interface/wx/uilocale.h index 7e7c521352..18d4de488d 100644 --- a/interface/wx/uilocale.h +++ b/interface/wx/uilocale.h @@ -340,7 +340,7 @@ public: /** Set language. - Return reference to @this for method chaining. + Return reference to `this` for method chaining. See https://www.loc.gov/standards/iso639-2/php/English_list.php for the list of all language codes. @@ -353,7 +353,7 @@ public: /** Set region. - Return reference to @this for method chaining. + Return reference to `this` for method chaining. @param region It specifies an uppercase ISO 3166-1 country/region identifier. @@ -365,7 +365,7 @@ public: Note that script value is currently ignored under Unix systems. - Return reference to @this for method chaining. + Return reference to `this` for method chaining. @param script It is an initial-uppercase ISO 15924 script code. @@ -378,7 +378,7 @@ public: Note that this value is only used under Unix systems and simply ignored under the other ones. - Return reference to @this for method chaining. + Return reference to `this` for method chaining. @param charset Charset is a string such as "UTF-8", "ISO855915" or "KOI8R". @@ -392,7 +392,7 @@ public: Note that this value is only used under Unix systems and simply ignored under the other ones. - Return reference to @this for method chaining. + Return reference to `this` for method chaining. @param modifier Modifier is defined by ISO/IEC 15897. @@ -418,9 +418,9 @@ public: /** Construct platform dependent name. Format: - Windows: -