Merge branch 'im/doxyfix2' of https://github.com/imciner2/wxWidgets

Fix various documentation problems.

See https://github.com/wxWidgets/wxWidgets/pull/2367

interface/wx/colour.h

@@ -9,9 +9,8 @@
 
 /**
     Flags for wxColour -> wxString conversion (see wxColour::GetAsString).
-
-    @{
 */
+//@{
 enum {
     wxC2S_NAME             = 1,   // return colour name, when possible
     wxC2S_CSS_SYNTAX       = 2,   // return colour in rgb(r,g,b) syntax

interface/wx/debug.h

@@ -18,8 +18,6 @@
 void wxAbort();
 
 /**
-    @def wxDEBUG_LEVEL
-
     Preprocessor symbol defining the level of debug support available.
 
     This symbol is defined to 1 by default meaning that asserts are compiled in
@@ -40,8 +38,6 @@ void wxAbort();
 #define wxDEBUG_LEVEL
 
 /**
-    @def __WXDEBUG__
-
     Compatibility macro indicating presence of debug support.
 
     This symbol is defined if wxDEBUG_LEVEL is greater than 0 and undefined
@@ -275,8 +271,6 @@ typedef void (*wxAssertHandler_t)(const wxString& file,
 void wxDisableAsserts();
 
 /**
-    @def wxDISABLE_ASSERTS_IN_RELEASE_BUILD
-
     Use this macro to disable asserts in release build when not using
     wxIMPLEMENT_APP().
 

interface/wx/dirdlg.h

@@ -47,7 +47,7 @@ const char wxDirDialogNameStr[] = "wxDirCtrl";
     @style{wxDD_CHANGE_DIR}
            Change the current working directory to the directory chosen by the
            user.
-           @note This flag cannot be used with the @c wxDD_MULTIPLE style.
+           This flag cannot be used with the @c wxDD_MULTIPLE style.
     @style{wxDD_MULTIPLE}
            Allow the user to select multiple directories.
            This flag is only available since wxWidgets 3.1.4

interface/wx/filectrl.h

@@ -91,9 +91,6 @@ public:
             Initial size.
         @param name
             Control name.
-
-        @return @true if the control was successfully created or @false if
-                 creation failed.
     */
 
     wxFileCtrl(wxWindow* parent, wxWindowID id,
@@ -107,6 +104,9 @@ public:
 
     /**
         Create function for two-step construction. See wxFileCtrl() for details.
+
+        @return @true if the control was successfully created or @false if
+                 creation failed.
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& defaultDirectory = wxEmptyString,

interface/wx/gauge.h

@@ -58,7 +58,6 @@
            Windows 7 and later and the dock icon under macOS, ignored under
            the other platforms.
            This flag is only available in wxWidgets 3.1.0 and later.
-
     @endStyleTable
 
     @library{wxcore}

interface/wx/listbox.h

@@ -350,7 +350,7 @@ public:
 
         @since 3.1.4
      */
-    virtual void MSWSetTabStops(const wxVector<int>& tabStops);
+    virtual bool MSWSetTabStops(const wxVector<int>& tabStops);
 
     // NOTE: Phoenix needs to see the implementation of pure virtuals so it
     // knows that this class is not abstract.

interface/wx/listctrl.h

@@ -151,7 +151,7 @@ enum
     2.8 was removed in wxWidgets 3.1, meaning for wxWidgets 3.1+ wxOSX uses the generic
     implementation for all modes.
 
-    @subsection column_order Column Ordering
+    @section column_order Column Ordering
 
     By default, the columns of a list control appear on the screen in order
     of their indices, i.e. column 0 appears first, then column 1 next,

interface/wx/menu.h

@@ -952,7 +952,7 @@ public:
         @return
             @true if the command was handled, @false otherwise.
 
-        @onlyfor{wxMSW}
+        @onlyfor{wxmsw}
 
         @since 3.1.5
     */

interface/wx/pen.h

@@ -192,7 +192,6 @@ public:
      */
     wxPenInfo& HighQuality();
 
-    wxPenInfo& LowQuality();
     wxColour GetColour() const;
     wxBitmap GetStipple() const;
     wxPenStyle GetStyle() const;
@@ -202,7 +201,7 @@ public:
     int GetDashes(wxDash **ptr);
     int GetDashCount() const;
     wxDash* GetDash() const;
-    bool IsTransparent() const;    
+    bool IsTransparent() const;
     int GetWidth() const;
 };
 

interface/wx/webview.h

@@ -309,7 +309,7 @@ public:
     WebKit on macOS and GTK. This allows the correct viewing of complex pages with
     JavaScript and CSS.
 
-    @section descriptions Backend Descriptions
+    @section backend_descriptions Backend Descriptions
 
     This class supports using multiple backends, corresponding to different
     implementations of the same functionality. Under macOS and Unix platforms
@@ -771,8 +771,8 @@ public:
         Add a script message handler with the given name.
 
         To use the script message handler from javascript use
-        @c window.<name>.postMessage(<messageBody>) where <name> corresponds the value
-        of the name parameter. The <messageBody> will be available to the application
+        @c `window.<name>.postMessage(<messageBody>)` where `<name>` corresponds the value
+        of the name parameter. The `<messageBody>` will be available to the application
         via a @c wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED event.
 
         Sample C++ code receiving a script message:

interface/wx/windowid.h

@@ -50,8 +50,6 @@ public:
             The first of the range of IDs to unreserve.
         @param count
             The number of sequential IDs to unreserve.
-
-        @return The value of the first ID in the sequence, or wxID_NONE.
     */
     static void UnreserveId(wxWindowID id, int count = 1);
 };