Correct wxDropSource constructors documentation.

The types of the arguments (wxCursor vs wxIcon) were inversed. Even though the
description correctly said that wxCursor version was used by MSW and wxIcon --
by wxGTK the converse was actually documented.

Fix this and also mention OS X.

Finally remove the unnecessary and useless destructor documentation.

Closes #13856.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70326 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/dnd.h b/interface/wx/dnd.h
index 34f9ba6fc709148347c65e2a28dfec6066688c3a..bdc65be16b917e8c8c6b02a9b80dbfe815082a16 100644 (file)
--- a/interface/wx/dnd.h
+++ b/interface/wx/dnd.h
@@ -188,8 +188,8 @@ public:
         This constructor requires that you must call SetData() later.
 
         Note that the type of @a iconCopy and subsequent parameters
         This constructor requires that you must call SetData() later.
 
         Note that the type of @a iconCopy and subsequent parameters

-        differs between different ports: these are cursors under Windows but
-        icons for GTK. You should use the macro wxDROP_ICON() in portable
+        differs between different ports: these are cursors under Windows and OS
+        X but icons for GTK. You should use the macro wxDROP_ICON() in portable

         programs instead of directly using either of these types.
 
         @onlyfor{wxmsw,wxosx}
         programs instead of directly using either of these types.
 
         @onlyfor{wxmsw,wxosx}


@@ -204,16 +204,16 @@ public:
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxWindow* win = NULL,
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxWindow* win = NULL,

-                 const wxIcon& iconCopy = wxNullIcon,
-                 const wxIcon& iconMove = wxNullIcon,
-                 const wxIcon& iconNone = wxNullIcon);
+                 const wxCursor& iconCopy = wxNullIcon,
+                 const wxCursor& iconMove = wxNullIcon,
+                 const wxCursor& iconNone = wxNullIcon);

 
     /**
 
     /**

-        The constructor for wxDataObject.
+        The constructor taking a wxDataObject.

 
         Note that the type of @a iconCopy and subsequent parameters
 
         Note that the type of @a iconCopy and subsequent parameters

-        differs between different ports: these are cursors under Windows but
-        icons for GTK. You should use the macro wxDROP_ICON() in portable
+        differs between different ports: these are cursors under Windows and OS
+        X but icons for GTK. You should use the macro wxDROP_ICON() in portable

         programs instead of directly using either of these types.
 
         @onlyfor{wxmsw,wxosx}
         programs instead of directly using either of these types.
 
         @onlyfor{wxmsw,wxosx}


@@ -230,17 +230,15 @@ public:
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxDataObject& data, wxWindow* win = NULL,
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxDataObject& data, wxWindow* win = NULL,

-                 const wxIcon& iconCopy = wxNullIcon,
-                 const wxIcon& iconMove = wxNullIcon,
-                 const wxIcon& iconNone = wxNullIcon);
+                 const wxCursor& iconCopy = wxNullIcon,
+                 const wxCursor& iconMove = wxNullIcon,
+                 const wxCursor& iconNone = wxNullIcon);

 
     /**
         This constructor requires that you must call SetData() later.
 
 
     /**
         This constructor requires that you must call SetData() later.
 

-        Note that the type of @a iconCopy and subsequent parameters
-        differs between different ports: these are cursors under Windows but
-        icons for GTK. You should use the macro wxDROP_ICON() in portable
-        programs instead of directly using either of these types.
+        This is the wxGTK-specific version of the constructor taking wxIcon
+        instead of wxCursor as the other ports.

 
         @onlyfor{wxgtk}
 
 
         @onlyfor{wxgtk}
 


@@ -254,17 +252,15 @@ public:
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxWindow* win = NULL,
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxWindow* win = NULL,

-                 const wxCursor& iconCopy = wxNullCursor,
-                 const wxCursor& iconMove = wxNullCursor,
-                 const wxCursor& iconNone = wxNullCursor);
+                 const wxIcon& iconCopy = wxNullCursor,
+                 const wxIcon& iconMove = wxNullCursor,
+                 const wxIcon& iconNone = wxNullCursor);

 
     /**
 
     /**

-        The constructor for wxDataObject.
+        The constructor taking a wxDataObject.

 
 

-        Note that the type of @a iconCopy and subsequent parameters
-        differs between different ports: these are cursors under Windows but
-        icons for GTK. You should use the macro wxDROP_ICON() in portable
-        programs instead of directly using either of these types.
+        This is the wxGTK-specific version of the constructor taking wxIcon
+        instead of wxCursor as the other ports.

 
         @onlyfor{wxgtk}
 
 
         @onlyfor{wxgtk}
 


@@ -280,14 +276,9 @@ public:
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxDataObject& data, wxWindow* win = NULL,
             The icon or cursor used for feedback when operation can't be done.
     */
     wxDropSource(wxDataObject& data, wxWindow* win = NULL,

-                 const wxCursor& iconCopy = wxNullCursor,
-                 const wxCursor& iconMove = wxNullCursor,
-                 const wxCursor& iconNone = wxNullCursor);
-
-    /**
-        Default constructor.
-    */
-    virtual ~wxDropSource();
+                 const wxIcon& iconCopy = wxNullCursor,
+                 const wxIcon& iconMove = wxNullCursor,
+                 const wxIcon& iconNone = wxNullCursor);

 
     /**
         Starts the drag-and-drop operation which will terminate when the user
 
     /**
         Starts the drag-and-drop operation which will terminate when the user