]> git.saurik.com Git - wxWidgets.git/commitdiff
Fix various doxygen warnings
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Fri, 19 Mar 2010 22:35:30 +0000 (22:35 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Fri, 19 Mar 2010 22:35:30 +0000 (22:35 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63713 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/doxygen/groups/class_ribbon.h
docs/doxygen/mainpages/samples.h
interface/wx/dataview.h
interface/wx/debugrpt.h
interface/wx/propgrid/editors.h
interface/wx/propgrid/propgrid.h
interface/wx/uiaction.h

index 16e23b99982bbe48ee77eb703437f10cc809e757..c9a35b7f67da48f3a2e8c62e4c3f94c5271afd4e 100644 (file)
@@ -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.
 
 */
index fead85090df0c83f39b10e8edba5df4f2d578812..1cf41b51ed96fdedd67eebccefca2766411b87a2 100644 (file)
@@ -141,7 +141,7 @@ TODO: Organize them in a more human-readable way.
 @endTable
 
 
-<hr/>
+<hr>
 
 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
index f02803df969ce8bdeaa70003a60cc24ec0582428..f678bb7f23e65e41eb549753aa4eec7a4f93affe 100644 (file)
@@ -100,7 +100,7 @@ public:
 
         @since 2.9.1
 
-        @param variable
+        @param variant
             The new value.
         @param item
             The item (row) to update.
index 0db0c4dd8fbe8ab3144f94e7b90aba0542875d21..f1955728508a312fba5dbfc3a10e8a00ff886ff7 100644 (file)
@@ -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
index 248c45fb3c446cdeebfb057420c1b89579ae757e..c74c2816a1b22e72c4fed0a7991366f0a418a152 100644 (file)
@@ -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,
index 2faa02dc4d365b49821259c6d600a436f54ef74f..4f540172f55cc015a6be0e8a839ade545378422c 100644 (file)
@@ -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.
 
index dbb83ccf9fd53b3e98a3a90a26db4594480cb735..cc8ad98e31cd58d55b03978fb6c22c5adbf4f549 100644 (file)
@@ -147,4 +147,3 @@ class wxUIActionSimulator
     bool        Char(int keycode, bool shiftDown=false, bool cmdDown=false, bool altDown=false);
 };
 
-#endif