From d86f721af3854980a8ce99e8fb3593f553d4ef1b Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Fri, 19 Mar 2010 22:35:30 +0000 Subject: [PATCH 1/1] Fix various doxygen warnings git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63713 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/groups/class_ribbon.h | 4 +--- docs/doxygen/mainpages/samples.h | 2 +- interface/wx/dataview.h | 2 +- interface/wx/debugrpt.h | 2 +- interface/wx/propgrid/editors.h | 15 ++++++--------- interface/wx/propgrid/propgrid.h | 4 +++- interface/wx/uiaction.h | 1 - 7 files changed, 13 insertions(+), 17 deletions(-) diff --git a/docs/doxygen/groups/class_ribbon.h b/docs/doxygen/groups/class_ribbon.h index 16e23b9998..c9a35b7f67 100644 --- a/docs/doxygen/groups/class_ribbon.h +++ b/docs/doxygen/groups/class_ribbon.h @@ -14,8 +14,6 @@ The wxRibbon library is a set of classes for writing a ribbon user interface. At the most generic level, this is a combination of a tab control with a toolbar. At a more functional level, it is similar to the user interface -present in recent versions of Micrsoft Office. - -Related Overviews: @ref overview_ribbon +present in recent versions of Microsoft Office. */ diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h index fead85090d..1cf41b51ed 100644 --- a/docs/doxygen/mainpages/samples.h +++ b/docs/doxygen/mainpages/samples.h @@ -141,7 +141,7 @@ TODO: Organize them in a more human-readable way. @endTable -
+
Notice that all wxWidgets samples mentioned above can be found in @c samples subdirectory of the library distribution. When a @c foobar sample is mentioned diff --git a/interface/wx/dataview.h b/interface/wx/dataview.h index f02803df96..f678bb7f23 100644 --- a/interface/wx/dataview.h +++ b/interface/wx/dataview.h @@ -100,7 +100,7 @@ public: @since 2.9.1 - @param variable + @param variant The new value. @param item The item (row) to update. diff --git a/interface/wx/debugrpt.h b/interface/wx/debugrpt.h index 0db0c4dd8f..f195572850 100644 --- a/interface/wx/debugrpt.h +++ b/interface/wx/debugrpt.h @@ -98,7 +98,7 @@ public: By default, a unique name constructed from wxApp::GetAppName(), the current process id and the current date and time is used. - @param dir + @param name The base name (i.e. without extension) of the file. @since 2.9.1 diff --git a/interface/wx/propgrid/editors.h b/interface/wx/propgrid/editors.h index 248c45fb3c..c74c2816a1 100644 --- a/interface/wx/propgrid/editors.h +++ b/interface/wx/propgrid/editors.h @@ -119,17 +119,14 @@ public: Default implementation sets foreground colour, background colour, font, plus text for wxTextCtrl and wxComboCtrl. - @param appearance - New appearance to be applied. + The parameter @a appearance represents the new appearance to be applied. - @param oldAppearance - Previously applied appearance. Used to detect which - control attributes need to be changed (e.g. so we only - change background colour if really needed). + The parameter @a oldAppearance is the previously applied appearance. + Used to detect which control attributes need to be changed (e.g. so we only + change background colour if really needed). - @param unspecified - @true if the new appearance represents an unspecified - property value. + Finally, the parameter @a unspecified if @true tells this function that + the new appearance represents an unspecified property value. */ virtual void SetControlAppearance( wxPropertyGrid* pg, wxPGProperty* property, diff --git a/interface/wx/propgrid/propgrid.h b/interface/wx/propgrid/propgrid.h index 2faa02dc4d..4f540172f5 100644 --- a/interface/wx/propgrid/propgrid.h +++ b/interface/wx/propgrid/propgrid.h @@ -491,7 +491,7 @@ public: @see EndLabelEdit(), MakeColumnEditable() */ - void BeginLabelEdit( unsigned int column = 0 ); + void BeginLabelEdit( unsigned int colIndex = 0 ); /** Changes value of a property, as if from an editor. Use this instead of @@ -795,6 +795,8 @@ public: /** Makes given column editable by user. + @param column + The index of the column to make editable. @param editable Using @false here will disable column from being editable. diff --git a/interface/wx/uiaction.h b/interface/wx/uiaction.h index dbb83ccf9f..cc8ad98e31 100644 --- a/interface/wx/uiaction.h +++ b/interface/wx/uiaction.h @@ -147,4 +147,3 @@ class wxUIActionSimulator bool Char(int keycode, bool shiftDown=false, bool cmdDown=false, bool altDown=false); }; -#endif -- 2.47.2