From dc770deab00eeded2d42e030d62becd9f21c993f Mon Sep 17 00:00:00 2001 From: PB Date: Fri, 11 Mar 2022 19:58:03 +0100 Subject: [PATCH] Fix typos and wording in docs and comments Closes #22191. --- include/wx/msw/wrapwin.h | 2 +- interface/wx/app.h | 2 +- interface/wx/datetime.h | 3 +-- interface/wx/platinfo.h | 6 +++--- interface/wx/settings.h | 2 +- 5 files changed, 7 insertions(+), 8 deletions(-) diff --git a/include/wx/msw/wrapwin.h b/include/wx/msw/wrapwin.h index 3f7ae7d45f..fb7faa3340 100644 --- a/include/wx/msw/wrapwin.h +++ b/include/wx/msw/wrapwin.h @@ -52,7 +52,7 @@ #pragma warning(pop) #endif -// #undef the macros defined in winsows.h which conflict with code elsewhere +// #undef the macros defined in windows.h which conflict with code elsewhere #include "wx/msw/winundef.h" #endif // _WX_WRAPWIN_H_ diff --git a/interface/wx/app.h b/interface/wx/app.h index 3d0f92ab3a..dbb5d8bfea 100644 --- a/interface/wx/app.h +++ b/interface/wx/app.h @@ -789,7 +789,7 @@ public: In addition to the features provided by wxAppConsole it keeps track of the top window (see SetTopWindow()) and adds support for - video modes (see SetVideoMode()). + video modes (see SetDisplayMode()). In general, application-wide settings for GUI-only apps are accessible from wxApp (or from wxSystemSettings or wxSystemOptions classes). diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h index 3d5fb42268..1115ccc898 100644 --- a/interface/wx/datetime.h +++ b/interface/wx/datetime.h @@ -147,8 +147,7 @@ public: NZST = GMT12, //!< Standard Time NZDT = GMT13, //!< Daylight Saving Time - /// Universal Coordinated Time = the new and politically correct name - /// for GMT. + /// Universal Coordinated Time UTC = GMT0 }; diff --git a/interface/wx/platinfo.h b/interface/wx/platinfo.h index 84dce32573..cd57099be5 100644 --- a/interface/wx/platinfo.h +++ b/interface/wx/platinfo.h @@ -20,7 +20,7 @@ */ enum wxOperatingSystemId { - wxOS_UNKNOWN = 0, //!< returned on error + wxOS_UNKNOWN = 0, //!< Returned on error. wxOS_MAC_OS = 1 << 0, //!< Apple Mac OS 8/9/X with Mac paths wxOS_MAC_OSX_DARWIN = 1 << 1, //!< Apple macOS with Unix paths @@ -28,7 +28,7 @@ enum wxOperatingSystemId //! A combination of all @c wxOS_MAC_* values previously listed. wxOS_MAC = wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN, - wxOS_WINDOWS_NT = 1 << 3, //!< Windows NT family (XP/Vista/7/8/10) + wxOS_WINDOWS_NT = 1 << 3, //!< Windows NT family (XP/Vista/7/8/10/11) //! Any Windows system, currently can be only wxOS_WINDOWS_NT. wxOS_WINDOWS = wxOS_WINDOWS_NT, @@ -640,7 +640,7 @@ public: }; /** - Returns true only for MSW programs running under Wine. + Returns @true only for MSW programs running under Wine. This function can be used to check for some functionality not implemented when using Wine. diff --git a/interface/wx/settings.h b/interface/wx/settings.h index b860a8f639..d5b52d7eb3 100644 --- a/interface/wx/settings.h +++ b/interface/wx/settings.h @@ -363,7 +363,7 @@ public: @a win is a pointer to the window for which the metric is requested. Specifying the @a win parameter is encouraged, because some metrics on some - ports are not supported without one,or they might be capable of reporting + ports are not supported without one, or they might be capable of reporting better values if given one. If a window does not make sense for a metric, one should still be given, as for example it might determine which displays cursor width is requested with wxSYS_CURSOR_X.