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
This commit is contained in:
Steve Lamerton
2013-08-21 13:24:48 +00:00
parent 3a4cf8a84d
commit 591805e0b8
3 changed files with 11 additions and 9 deletions

View File

@@ -2084,7 +2084,7 @@ public:
/**
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).
*/
@@ -3563,7 +3563,7 @@ public:
/**
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).
*/
@@ -3664,7 +3664,7 @@ public:
/**
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
@@ -3680,10 +3680,10 @@ public:
/**
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.
@param label
@param bitmap
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.
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).
*/

View File

@@ -494,6 +494,8 @@ public:
/**
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.
*/
@@ -2290,7 +2292,7 @@ public:
@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);

View File

@@ -340,13 +340,13 @@ public:
/**
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,
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);