minor fixes to reduce number of Doxygen warnings
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64290 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -38,7 +38,7 @@ This manual contains a class reference and topic overviews.
|
|||||||
For a selection of wxWidgets tutorials, please see the documentation page
|
For a selection of wxWidgets tutorials, please see the documentation page
|
||||||
on the wxWidgets web site: http://www.wxwidgets.org.
|
on the wxWidgets web site: http://www.wxwidgets.org.
|
||||||
|
|
||||||
Please note that in the following, ``MS Windows" often refers to all
|
Please note that in the following, "MS Windows" often refers to all
|
||||||
platforms related to Microsoft Windows, including 32-bit and 64-bit
|
platforms related to Microsoft Windows, including 32-bit and 64-bit
|
||||||
variants, unless otherwise stated. All trademarks are acknowledged.
|
variants, unless otherwise stated. All trademarks are acknowledged.
|
||||||
|
|
||||||
|
@@ -10,7 +10,7 @@
|
|||||||
@class wxBufferedDC
|
@class wxBufferedDC
|
||||||
|
|
||||||
This class provides a simple way to avoid flicker: when drawing on it,
|
This class provides a simple way to avoid flicker: when drawing on it,
|
||||||
everything is in fact first drawn on an in-memory buffer (a wxBitmap) and
|
everything is infact first drawn on an in-memory buffer (a wxBitmap) and
|
||||||
then copied to the screen, using the associated wxDC, only once, when this
|
then copied to the screen, using the associated wxDC, only once, when this
|
||||||
object is destroyed. wxBufferedDC itself is typically associated with
|
object is destroyed. wxBufferedDC itself is typically associated with
|
||||||
wxClientDC, if you want to use it in your @c EVT_PAINT handler, you should
|
wxClientDC, if you want to use it in your @c EVT_PAINT handler, you should
|
||||||
@@ -48,7 +48,6 @@ public:
|
|||||||
*/
|
*/
|
||||||
wxBufferedDC();
|
wxBufferedDC();
|
||||||
|
|
||||||
//@{
|
|
||||||
/**
|
/**
|
||||||
Creates a buffer for the provided @a dc. Init() must not be called when
|
Creates a buffer for the provided @a dc. Init() must not be called when
|
||||||
using this constructor.
|
using this constructor.
|
||||||
@@ -89,7 +88,6 @@ public:
|
|||||||
*/
|
*/
|
||||||
wxBufferedDC(wxDC* dc, wxBitmap& buffer = wxNullBitmap,
|
wxBufferedDC(wxDC* dc, wxBitmap& buffer = wxNullBitmap,
|
||||||
int style = wxBUFFER_CLIENT_AREA);
|
int style = wxBUFFER_CLIENT_AREA);
|
||||||
//@}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Copies everything drawn on the DC so far to the underlying DC
|
Copies everything drawn on the DC so far to the underlying DC
|
||||||
|
@@ -289,7 +289,7 @@ void wxDisableAsserts();
|
|||||||
Will always generate an assert error with specified message if this code is
|
Will always generate an assert error with specified message if this code is
|
||||||
reached (in debug mode).
|
reached (in debug mode).
|
||||||
|
|
||||||
This macro is useful for marking unreachable" code areas, for example it
|
This macro is useful for marking "unreachable" code areas, for example it
|
||||||
may be used in the "default:" branch of a switch statement if all possible
|
may be used in the "default:" branch of a switch statement if all possible
|
||||||
cases are processed above.
|
cases are processed above.
|
||||||
|
|
||||||
|
@@ -496,13 +496,21 @@ public:
|
|||||||
If allowOthers is @true, the user can type a string not in choices
|
If allowOthers is @true, the user can type a string not in choices
|
||||||
array.
|
array.
|
||||||
*/
|
*/
|
||||||
//@{
|
|
||||||
wxGridCellChoiceEditor(size_t count = 0,
|
wxGridCellChoiceEditor(size_t count = 0,
|
||||||
const wxString choices[] = NULL,
|
const wxString choices[] = NULL,
|
||||||
bool allowOthers = false);
|
bool allowOthers = false);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Choice cell renderer ctor.
|
||||||
|
|
||||||
|
@param choices
|
||||||
|
An array of strings from which the user can choose.
|
||||||
|
@param allowOthers
|
||||||
|
If allowOthers is @true, the user can type a string not in choices
|
||||||
|
array.
|
||||||
|
*/
|
||||||
wxGridCellChoiceEditor(const wxArrayString& choices,
|
wxGridCellChoiceEditor(const wxArrayString& choices,
|
||||||
bool allowOthers = false);
|
bool allowOthers = false);
|
||||||
//@}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Parameters string format is "item1[,item2[...,itemN]]"
|
Parameters string format is "item1[,item2[...,itemN]]"
|
||||||
|
@@ -312,11 +312,6 @@ public:
|
|||||||
The bitmap used when the tool is disabled. If it is equal to
|
The bitmap used when the tool is disabled. If it is equal to
|
||||||
::wxNullBitmap (default), the disabled bitmap is automatically
|
::wxNullBitmap (default), the disabled bitmap is automatically
|
||||||
generated by greying the normal one.
|
generated by greying the normal one.
|
||||||
@param shortHelpString
|
|
||||||
This string is used for the tools tooltip.
|
|
||||||
@param longHelpString
|
|
||||||
This string is shown in the statusbar (if any) of the parent frame
|
|
||||||
when the mouse pointer is inside the tool.
|
|
||||||
@param kind
|
@param kind
|
||||||
May be ::wxITEM_NORMAL for a normal button (default), ::wxITEM_CHECK
|
May be ::wxITEM_NORMAL for a normal button (default), ::wxITEM_CHECK
|
||||||
for a checkable tool (such tool stays pressed after it had been
|
for a checkable tool (such tool stays pressed after it had been
|
||||||
@@ -325,6 +320,11 @@ public:
|
|||||||
whenever another button in the group is checked. ::wxITEM_DROPDOWN
|
whenever another button in the group is checked. ::wxITEM_DROPDOWN
|
||||||
specifies that a drop-down menu button will appear next to the
|
specifies that a drop-down menu button will appear next to the
|
||||||
tool button (only GTK+ and MSW). Call SetDropdownMenu() afterwards.
|
tool button (only GTK+ and MSW). Call SetDropdownMenu() afterwards.
|
||||||
|
@param shortHelpString
|
||||||
|
This string is used for the tools tooltip.
|
||||||
|
@param longHelpString
|
||||||
|
This string is shown in the statusbar (if any) of the parent frame
|
||||||
|
when the mouse pointer is inside the tool.
|
||||||
@param clientData
|
@param clientData
|
||||||
An optional pointer to client data which can be retrieved later
|
An optional pointer to client data which can be retrieved later
|
||||||
using GetToolClientData().
|
using GetToolClientData().
|
||||||
|
Reference in New Issue
Block a user