From 001f1f56787a37b086f2bff452c5b47166064bcb Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Tue, 11 May 2010 19:44:16 +0000 Subject: [PATCH] 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 --- docs/doxygen/mainpages/introduction.h | 2 +- interface/wx/dcbuffer.h | 4 +--- interface/wx/debug.h | 2 +- interface/wx/grid.h | 12 ++++++++++-- interface/wx/toolbar.h | 10 +++++----- 5 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/doxygen/mainpages/introduction.h b/docs/doxygen/mainpages/introduction.h index 0db2ee14fa..763ce481de 100644 --- a/docs/doxygen/mainpages/introduction.h +++ b/docs/doxygen/mainpages/introduction.h @@ -38,7 +38,7 @@ This manual contains a class reference and topic overviews. For a selection of wxWidgets tutorials, please see the documentation page 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 variants, unless otherwise stated. All trademarks are acknowledged. diff --git a/interface/wx/dcbuffer.h b/interface/wx/dcbuffer.h index 55c61c9483..9a4628132d 100644 --- a/interface/wx/dcbuffer.h +++ b/interface/wx/dcbuffer.h @@ -10,7 +10,7 @@ @class wxBufferedDC 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 object is destroyed. wxBufferedDC itself is typically associated with wxClientDC, if you want to use it in your @c EVT_PAINT handler, you should @@ -48,7 +48,6 @@ public: */ wxBufferedDC(); - //@{ /** Creates a buffer for the provided @a dc. Init() must not be called when using this constructor. @@ -89,7 +88,6 @@ public: */ wxBufferedDC(wxDC* dc, wxBitmap& buffer = wxNullBitmap, int style = wxBUFFER_CLIENT_AREA); - //@} /** Copies everything drawn on the DC so far to the underlying DC diff --git a/interface/wx/debug.h b/interface/wx/debug.h index 8803ff2546..d805f21e52 100644 --- a/interface/wx/debug.h +++ b/interface/wx/debug.h @@ -289,7 +289,7 @@ void wxDisableAsserts(); Will always generate an assert error with specified message if this code is 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 cases are processed above. diff --git a/interface/wx/grid.h b/interface/wx/grid.h index 4fe31735bc..fb68f5dcc8 100644 --- a/interface/wx/grid.h +++ b/interface/wx/grid.h @@ -496,13 +496,21 @@ public: If allowOthers is @true, the user can type a string not in choices array. */ - //@{ wxGridCellChoiceEditor(size_t count = 0, const wxString choices[] = NULL, 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, bool allowOthers = false); - //@} /** Parameters string format is "item1[,item2[...,itemN]]" diff --git a/interface/wx/toolbar.h b/interface/wx/toolbar.h index 5daf2418fe..90f2cab465 100644 --- a/interface/wx/toolbar.h +++ b/interface/wx/toolbar.h @@ -312,11 +312,6 @@ public: The bitmap used when the tool is disabled. If it is equal to ::wxNullBitmap (default), the disabled bitmap is automatically 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 May be ::wxITEM_NORMAL for a normal button (default), ::wxITEM_CHECK 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 specifies that a drop-down menu button will appear next to the 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 An optional pointer to client data which can be retrieved later using GetToolClientData().