Fix warnings in rich text documentation.

See #15346.

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

diff --git a/interface/wx/richtext/richtextbuffer.h b/interface/wx/richtext/richtextbuffer.h
index 080c2b3da37991bff3730022ec3681ceb0bf3a9a..2426e696c82fff7543b29a7082e1c518fcaa0e2e 100644 (file)
--- a/interface/wx/richtext/richtextbuffer.h
+++ b/interface/wx/richtext/richtextbuffer.h
@@ -2084,7 +2084,7 @@ public:
 
     /**
         Lay the item out at the specified position with the given size constraint.
 
     /**
         Lay the item out at the specified position with the given size constraint.

-        Layout must set the cached size. @rect is the available space for the object,
+        Layout must set the cached size. @a rect is the available space for the object,

         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */
         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */


@@ -3563,7 +3563,7 @@ public:
 
     /**
         Lay the item out at the specified position with the given size constraint.
 
     /**
         Lay the item out at the specified position with the given size constraint.

-        Layout must set the cached size. @rect is the available space for the object,
+        Layout must set the cached size. @a rect is the available space for the object,

         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */
         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */


@@ -3664,7 +3664,7 @@ public:
     /**
         Constructor, creating a field type definition with a text label.
 
     /**
         Constructor, creating a field type definition with a text label.
 

-        @param parent
+        @param name

             The name of the type definition. This must be unique, and is the type
             name used when adding a field to a control.
         @param label
             The name of the type definition. This must be unique, and is the type
             name used when adding a field to a control.
         @param label


@@ -3680,10 +3680,10 @@ public:
     /**
         Constructor, creating a field type definition with a bitmap label.
 
     /**
         Constructor, creating a field type definition with a bitmap label.
 

-        @param parent
+        @param name

             The name of the type definition. This must be unique, and is the type
             name used when adding a field to a control.
             The name of the type definition. This must be unique, and is the type
             name used when adding a field to a control.

-        @param label
+        @param bitmap

             The bitmap label to be shown on the field.
         @param displayStyle
             The display style: one of wxRICHTEXT_FIELD_STYLE_RECTANGLE,
             The bitmap label to be shown on the field.
         @param displayStyle
             The display style: one of wxRICHTEXT_FIELD_STYLE_RECTANGLE,


@@ -3728,7 +3728,7 @@ public:
 
     /**
         Lay the item out at the specified position with the given size constraint.
 
     /**
         Lay the item out at the specified position with the given size constraint.

-        Layout must set the cached size. @rect is the available space for the object,
+        Layout must set the cached size. @a rect is the available space for the object,

         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */
         and @a parentRect is the container that is used to determine a relative size
         or position (for example if a text box must be 50% of the parent text box).
     */

diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h
index 5dc60b137186559f2d1ec742e1ea57c135bce30a..5ade831af65bb7b09361f1232d0fbee01cf93d43 100644 (file)
--- a/interface/wx/richtext/richtextctrl.h
+++ b/interface/wx/richtext/richtextctrl.h
@@ -494,6 +494,8 @@ public:
 
     /**
         Sets the wxRichTextObject object that currently has the editing focus.
 
     /**
         Sets the wxRichTextObject object that currently has the editing focus.

+        @param obj
+            The wxRichTextObject to set focus on.

         @param setCaretPosition
             Optionally set the caret position.
     */
         @param setCaretPosition
             Optionally set the caret position.
     */


@@ -2290,7 +2292,7 @@ public:
 
         @param commandType
             The type of the event.
 
         @param commandType
             The type of the event.

-        @param id
+        @param winid

             Window identifier. The value @c wxID_ANY indicates a default value.
     */
     wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
             Window identifier. The value @c wxID_ANY indicates a default value.
     */
     wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);

diff --git a/interface/wx/richtext/richtextprint.h b/interface/wx/richtext/richtextprint.h
index 0f2199d6a2934f89d07dc6c966198cf461eb5147..fde7c7fc100b634e0f9d0db44b331f2f0b605e52 100644 (file)
--- a/interface/wx/richtext/richtextprint.h
+++ b/interface/wx/richtext/richtextprint.h
@@ -340,13 +340,13 @@ public:
 
     /**
         Prints the given buffer. The function takes its own copy of @a buffer.
 
     /**
         Prints the given buffer. The function takes its own copy of @a buffer.

-        @showPrintDialog can be @true to show the print dialog, or @false to print quietly.
+        @a showPrintDialog can be @true to show the print dialog, or @false to print quietly.

     */
     bool PrintBuffer(const wxRichTextBuffer& buffer, bool showPrintDialog = true);
 
     /**
         Prints the given file. @a richTextFile can be a text file or XML file,
     */
     bool PrintBuffer(const wxRichTextBuffer& buffer, bool showPrintDialog = true);
 
     /**
         Prints the given file. @a richTextFile can be a text file or XML file,

-        or other file depending on the available file handlers. @showPrintDialog
+        or other file depending on the available file handlers. @a showPrintDialog

         can be @true to show the print dialog, or @false to print quietly.
     */
     bool PrintFile(const wxString& richTextFile, bool showPrintDialog = true);
         can be @true to show the print dialog, or @false to print quietly.
     */
     bool PrintFile(const wxString& richTextFile, bool showPrintDialog = true);