fix miscellaneous doxygen warnings; IMPORTANT: never leave empty lines inside a ...

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

diff --git a/interface/wx/grid.h b/interface/wx/grid.h
index ad7250a984b4c7c4f0a9d8e2d51adfa800ed7051..763c62ecde01610a3c382553277b41a97a5629cd 100644 (file)
--- a/interface/wx/grid.h
+++ b/interface/wx/grid.h
@@ -1068,7 +1068,7 @@ public:
     - wxGridCellFloatEditor
     - wxGridCellNumberEditor
     - wxGridCellTextEditor
     - wxGridCellFloatEditor
     - wxGridCellNumberEditor
     - wxGridCellTextEditor

-    
+

     Please see wxGridEvent, wxGridSizeEvent, wxGridRangeSelectEvent, and
     wxGridEditorCreatedEvent for the documentation of all event types you can
     use with wxGrid.
     Please see wxGridEvent, wxGridSizeEvent, wxGridRangeSelectEvent, and
     wxGridEditorCreatedEvent for the documentation of all event types you can
     use with wxGrid.


@@ -1665,7 +1665,7 @@ public:
         See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
         more information.
     */
         See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
         more information.
     */

-    const wxString GetCellValue(const wxGridCellCoords& coords) const;
+    const wxString& GetCellValue(const wxGridCellCoords& coords) const;

 
     /**
         Returns a pointer to the current default grid cell editor.
 
     /**
         Returns a pointer to the current default grid cell editor.


@@ -2332,12 +2332,12 @@ public:
         This method takes an array containing the indices of the columns in
         their display order, i.e. uses the same convention as
         wxHeaderCtrl::SetColumnsOrder().
         This method takes an array containing the indices of the columns in
         their display order, i.e. uses the same convention as
         wxHeaderCtrl::SetColumnsOrder().

-     */
+    */

     void SetColumnsOrder(const wxArrayInt& order);
 
     /**
         Resets the position of the columns to the default.
     void SetColumnsOrder(const wxArrayInt& order);
 
     /**
         Resets the position of the columns to the default.

-     */
+    */

     void ResetColPos();
 
     //@}
     void ResetColPos();
 
     //@}


@@ -2345,7 +2345,7 @@ public:
 
     /**
         @name Cursor Movement
 
     /**
         @name Cursor Movement

-     */
+    */

     //@{
 
     /**
     //@{
 
     /**


@@ -3354,8 +3354,8 @@ public:
     @event{EVT_GRID_CELL_CHANGING(func)}
         The user is about to change the data in a cell. The new cell value as
         string is available from GetString() event object method. This event
     @event{EVT_GRID_CELL_CHANGING(func)}
         The user is about to change the data in a cell. The new cell value as
         string is available from GetString() event object method. This event

-        can be vetoed if the change is not allowed. Processes a @c
-        wxEVT_GRID_CELL_CHANGING event type.
+        can be vetoed if the change is not allowed.
+        Processes a @c wxEVT_GRID_CELL_CHANGING event type.

     @event{EVT_GRID_CELL_CHANGED(func)}
         The user changed the data in a cell. The old cell value as string is
         available from GetString() event object method. Notice that vetoing
     @event{EVT_GRID_CELL_CHANGED(func)}
         The user changed the data in a cell. The old cell value as string is
         available from GetString() event object method. Notice that vetoing


@@ -3406,7 +3406,6 @@ public:
         proceed in which case wxGrid::SetColPos() is used to reorder the
         columns display order without affecting the use of the column indices
         otherwise.
         proceed in which case wxGrid::SetColPos() is used to reorder the
         columns display order without affecting the use of the column indices
         otherwise.

-

         This event macro corresponds to @c wxEVT_GRID_COL_MOVE event type.
     @event{EVT_GRID_COL_SORT(func)}
         This event is generated when a column is clicked by the user and its
         This event macro corresponds to @c wxEVT_GRID_COL_MOVE event type.
     @event{EVT_GRID_COL_SORT(func)}
         This event is generated when a column is clicked by the user and its


@@ -3417,7 +3416,6 @@ public:
         (and not vetoed) the grid supposes that the table was indeed resorted
         and updates the column to indicate the new sort order and refreshes
         itself.
         (and not vetoed) the grid supposes that the table was indeed resorted
         and updates the column to indicate the new sort order and refreshes
         itself.

-

         This event macro corresponds to @c wxEVT_GRID_COL_SORT event type.
     @endEventTable
 
         This event macro corresponds to @c wxEVT_GRID_COL_SORT event type.
     @endEventTable
 

diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h
index 3c55bd704a3e1e99c163d3dd4b407e11491c032c..8f8287d224a2cd30b3a922ffd60aaf2d6822382d 100644 (file)
--- a/interface/wx/scrolwin.h
+++ b/interface/wx/scrolwin.h
@@ -287,7 +287,6 @@ public:
     */
     void GetScrollPixelsPerUnit(int* xUnit, int* yUnit) const;
 
     */
     void GetScrollPixelsPerUnit(int* xUnit, int* yUnit) const;
 

-    //@{

     /**
         Get the position at which the visible portion of the window starts.
 
     /**
         Get the position at which the visible portion of the window starts.
 


@@ -296,20 +295,24 @@ public:
         @param y
             Receives the first visible y position in scroll units.
 
         @param y
             Receives the first visible y position in scroll units.
 

-        @remarks If either of the scrollbars is not at the home position, x
-                 and/or y will be greater than zero.  Combined with
-                 wxWindow::GetClientSize(), the application can use this
-                 function to efficiently redraw only the visible portion
-                 of the window.  The positions are in logical scroll
-                 units, not pixels, so to convert to pixels you will
-                 have to multiply by the number of pixels per scroll
-                 increment.
+        @remarks
+            If either of the scrollbars is not at the home position, @a x
+            and/or @a y will be greater than zero.
+            Combined with wxWindow::GetClientSize(), the application can use this
+            function to efficiently redraw only the visible portion of the window.
+            The positions are in logical scroll units, not pixels, so to convert
+            to pixels you will have to multiply by the number of pixels per scroll
+            increment.

 
         @see SetScrollbars(), Scroll()
     */
     void GetViewStart(int* x, int* y) const;
 
         @see SetScrollbars(), Scroll()
     */
     void GetViewStart(int* x, int* y) const;

+
+    /**
+        This is a simple overload of GetViewStart(int*,int*); see that function
+        for more info.
+    */

     wxPoint GetViewStart() const;
     wxPoint GetViewStart() const;

-    //@}

 
     /**
         Gets the size in device units of the scrollable window area (as
 
     /**
         Gets the size in device units of the scrollable window area (as


@@ -352,7 +355,6 @@ public:
     */
     void PrepareDC(wxDC& dc);
 
     */
     void PrepareDC(wxDC& dc);
 

-    //@{

     /**
         Scrolls a window so the view start is at the given point.
 
     /**
         Scrolls a window so the view start is at the given point.
 


@@ -364,14 +366,17 @@ public:
         @remarks The positions are in scroll units, not pixels, so to convert to
                  pixels you will have to multiply by the number of
                  pixels per scroll increment. If either parameter is
         @remarks The positions are in scroll units, not pixels, so to convert to
                  pixels you will have to multiply by the number of
                  pixels per scroll increment. If either parameter is

-                 wxDefaultCoord (-1), that position will be ignored (no change
+                 ::wxDefaultCoord (-1), that position will be ignored (no change

                  in that direction).
 
         @see SetScrollbars(), GetScrollPixelsPerUnit()
     */
     void Scroll(int x, int y);
                  in that direction).
 
         @see SetScrollbars(), GetScrollPixelsPerUnit()
     */
     void Scroll(int x, int y);

+
+    /**
+        This is an overload of Scroll(int,int); see that function for more info.
+    */

     void Scroll(const wxPoint& pt);
     void Scroll(const wxPoint& pt);

-    //@}

 
     /**
         Set the horizontal and vertical scrolling increment only. See the
 
     /**
         Set the horizontal and vertical scrolling increment only. See the

diff --git a/interface/wx/unichar.h b/interface/wx/unichar.h
index ccc8edf53375a75f0cdaa59d7ff5328c96932686..fd058c1ddca970e9e5634fa2d661bd5d9685fe6e 100644 (file)
--- a/interface/wx/unichar.h
+++ b/interface/wx/unichar.h
@@ -28,7 +28,7 @@ public:
     /**
         Default ctor.
     */
     /**
         Default ctor.
     */

-    wxUniChar()
+    wxUniChar();

 
     //@{
     /**
 
     //@{
     /**

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 2cff03d16fb16494f54ee094d5284a0b5f4a13c6..1d465cf981a8fdc8f3aa95ee4fa14870002b201e 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -1075,10 +1075,9 @@ public:
         (or toggle or ...) any items which should be disabled in the menu
         before showing it.
 
         (or toggle or ...) any items which should be disabled in the menu
         before showing it.
 

-        @param menu
-            The menu to show.
-        @param pos
-            The position at which to show the menu in client coordinates.
+        The parameter @a menu is the menu to show.
+        The parameter @a pos (or the parameters @a x and @a y) is the
+        position at which to show the menu in client coordinates.

 
         @return
              The selected menu item id or @c wxID_NONE if none selected or an
 
         @return
              The selected menu item id or @c wxID_NONE if none selected or an