Fix stc doxygen warnings and regen stc files.

We need to manually escape a few parts of the autogenerated documentation. 

See #15346.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74783 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Steve Lamerton
2013-09-11 12:03:07 +00:00
parent 5ea01cd497
commit 11a23db531
5 changed files with 30 additions and 21 deletions

View File

@@ -3255,12 +3255,12 @@ public:
// Returns the length of the replacement text. // Returns the length of the replacement text.
int ReplaceTarget(const wxString& text); int ReplaceTarget(const wxString& text);
// Replace the target text with the argument text after \d processing. // Replace the target text with the argument text after \\d processing.
// Text is counted so it can contain NULs. // Text is counted so it can contain NULs.
// Looks for \d where d is between 1 and 9 and replaces these with the strings // Looks for \\d where d is between 1 and 9 and replaces these with the strings
// matched in the last search operation which were surrounded by \( and \). // matched in the last search operation which were surrounded by \( and \).
// Returns the length of the replacement text including any change // Returns the length of the replacement text including any change
// caused by processing the \d patterns. // caused by processing the \\d patterns.
int ReplaceTargetRE(const wxString& text); int ReplaceTargetRE(const wxString& text);
// Search for a counted string in the target and set the target to the found // Search for a counted string in the target and set the target to the found
@@ -3469,7 +3469,7 @@ public:
// Change the effect of pasting when there are multiple selections. // Change the effect of pasting when there are multiple selections.
void SetMultiPaste(int multiPaste); void SetMultiPaste(int multiPaste);
// Retrieve the effect of pasting when there are multiple selections.. // Retrieve the effect of pasting when there are multiple selections.
int GetMultiPaste() const; int GetMultiPaste() const;
// Retrieve the value of a tag from a regular expression search. // Retrieve the value of a tag from a regular expression search.

View File

@@ -2517,7 +2517,7 @@
TOWRITE TOWRITE
@endEventTable @endEventTable
@library{wxbase} @library{wxstc}
@category{stc} @category{stc}
@see wxStyledTextEvent @see wxStyledTextEvent
@@ -3734,12 +3734,12 @@ public:
int ReplaceTarget(const wxString& text); int ReplaceTarget(const wxString& text);
/** /**
Replace the target text with the argument text after \d processing. Replace the target text with the argument text after \\d processing.
Text is counted so it can contain NULs. Text is counted so it can contain NULs.
Looks for \d where d is between 1 and 9 and replaces these with the strings Looks for \\d where d is between 1 and 9 and replaces these with the strings
matched in the last search operation which were surrounded by \( and \). matched in the last search operation which were surrounded by \( and \).
Returns the length of the replacement text including any change Returns the length of the replacement text including any change
caused by processing the \d patterns. caused by processing the \\d patterns.
*/ */
int ReplaceTargetRE(const wxString& text); int ReplaceTargetRE(const wxString& text);
@@ -4080,7 +4080,7 @@ public:
void SetMultiPaste(int multiPaste); void SetMultiPaste(int multiPaste);
/** /**
Retrieve the effect of pasting when there are multiple selections.. Retrieve the effect of pasting when there are multiple selections.
*/ */
int GetMultiPaste() const; int GetMultiPaste() const;
@@ -5567,8 +5567,8 @@ public:
bold turns on bold bold turns on bold
italic turns on italics italic turns on italics
fore:[name or #RRGGBB] sets the foreground colour fore:[name or \#RRGGBB] sets the foreground colour
back:[name or #RRGGBB] sets the background colour back:[name or \#RRGGBB] sets the background colour
face:[facename] sets the font face name to use face:[facename] sets the font face name to use
size:[num] sets the font size in points size:[num] sets the font size in points
eol turns on eol filling eol turns on eol filling
@@ -5796,7 +5796,7 @@ public:
@todo list styled text ctrl events. @todo list styled text ctrl events.
@library{stc} @library{wxstc}
@category{events,stc} @category{events,stc}
*/ */

View File

@@ -614,7 +614,12 @@ methodOverrideMap = {
int %s(const wxString& text) { int %s(const wxString& text) {
const wxWX2MBbuf buf = wx2stc(text); const wxWX2MBbuf buf = wx2stc(text);
return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);''', return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);''',
0), ('Replace the target text with the argument text after \\\d processing.',
'Text is counted so it can contain NULs.',
'Looks for \\\d where d is between 1 and 9 and replaces these with the strings',
'matched in the last search operation which were surrounded by \( and \).',
'Returns the length of the replacement text including any change',
'caused by processing the \\\d patterns.',)),
'SearchInTarget' : 'SearchInTarget' :
(0, (0,
@@ -914,6 +919,10 @@ methodOverrideMap = {
return (void*)(sptr_t)SendMsg(%s, operation, (sptr_t)pointer); """, return (void*)(sptr_t)SendMsg(%s, operation, (sptr_t)pointer); """,
0), 0),
'GetMultiPaste' :
(0, 0, 0,
('Retrieve the effect of pasting when there are multiple selections.',)),
'' : ('', 0, 0, 0), '' : ('', 0, 0, 0),
} }

View File

@@ -1796,12 +1796,12 @@ int wxStyledTextCtrl::GetTargetEnd() const
return SendMsg(2194, wx2stclen(text, buf), (sptr_t)(const char*)buf); return SendMsg(2194, wx2stclen(text, buf), (sptr_t)(const char*)buf);
} }
// Replace the target text with the argument text after \d processing. // Replace the target text with the argument text after \\d processing.
// Text is counted so it can contain NULs. // Text is counted so it can contain NULs.
// Looks for \d where d is between 1 and 9 and replaces these with the strings // Looks for \\d where d is between 1 and 9 and replaces these with the strings
// matched in the last search operation which were surrounded by \( and \). // matched in the last search operation which were surrounded by \( and \).
// Returns the length of the replacement text including any change // Returns the length of the replacement text including any change
// caused by processing the \d patterns. // caused by processing the \\d patterns.
int wxStyledTextCtrl::ReplaceTargetRE(const wxString& text) { int wxStyledTextCtrl::ReplaceTargetRE(const wxString& text) {
const wxWX2MBbuf buf = wx2stc(text); const wxWX2MBbuf buf = wx2stc(text);
@@ -2210,7 +2210,7 @@ void wxStyledTextCtrl::SetMultiPaste(int multiPaste)
SendMsg(2614, multiPaste, 0); SendMsg(2614, multiPaste, 0);
} }
// Retrieve the effect of pasting when there are multiple selections.. // Retrieve the effect of pasting when there are multiple selections.
int wxStyledTextCtrl::GetMultiPaste() const int wxStyledTextCtrl::GetMultiPaste() const
{ {
return SendMsg(2615, 0, 0); return SendMsg(2615, 0, 0);

View File

@@ -110,7 +110,7 @@
TOWRITE TOWRITE
@endEventTable @endEventTable
@library{wxbase} @library{wxstc}
@category{stc} @category{stc}
@see wxStyledTextEvent @see wxStyledTextEvent
@@ -169,8 +169,8 @@ public:
bold turns on bold bold turns on bold
italic turns on italics italic turns on italics
fore:[name or #RRGGBB] sets the foreground colour fore:[name or \#RRGGBB] sets the foreground colour
back:[name or #RRGGBB] sets the background colour back:[name or \#RRGGBB] sets the background colour
face:[facename] sets the font face name to use face:[facename] sets the font face name to use
size:[num] sets the font size in points size:[num] sets the font size in points
eol turns on eol filling eol turns on eol filling
@@ -398,7 +398,7 @@ public:
@todo list styled text ctrl events. @todo list styled text ctrl events.
@library{stc} @library{wxstc}
@category{events,stc} @category{events,stc}
*/ */