From 11a23db53128bf244a089123b7fd27deb577a889 Mon Sep 17 00:00:00 2001 From: Steve Lamerton Date: Wed, 11 Sep 2013 12:03:07 +0000 Subject: [PATCH] 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 --- include/wx/stc/stc.h | 8 ++++---- interface/wx/stc/stc.h | 16 ++++++++-------- src/stc/gen_iface.py | 11 ++++++++++- src/stc/stc.cpp | 8 ++++---- src/stc/stc.interface.h.in | 8 ++++---- 5 files changed, 30 insertions(+), 21 deletions(-) diff --git a/include/wx/stc/stc.h b/include/wx/stc/stc.h index 434783c..7ffab64 100644 --- a/include/wx/stc/stc.h +++ b/include/wx/stc/stc.h @@ -3255,12 +3255,12 @@ public: // Returns the length of the replacement 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. - // 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 \). // 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); // 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. 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; // Retrieve the value of a tag from a regular expression search. diff --git a/interface/wx/stc/stc.h b/interface/wx/stc/stc.h index 638bf5f..18c2117 100644 --- a/interface/wx/stc/stc.h +++ b/interface/wx/stc/stc.h @@ -2517,7 +2517,7 @@ TOWRITE @endEventTable - @library{wxbase} + @library{wxstc} @category{stc} @see wxStyledTextEvent @@ -3734,12 +3734,12 @@ public: 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. - 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 \). 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); @@ -4080,7 +4080,7 @@ public: 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; @@ -5567,8 +5567,8 @@ public: bold turns on bold italic turns on italics - fore:[name or #RRGGBB] sets the foreground colour - back:[name or #RRGGBB] sets the background colour + fore:[name or \#RRGGBB] sets the foreground colour + back:[name or \#RRGGBB] sets the background colour face:[facename] sets the font face name to use size:[num] sets the font size in points eol turns on eol filling @@ -5796,7 +5796,7 @@ public: @todo list styled text ctrl events. - @library{stc} + @library{wxstc} @category{events,stc} */ diff --git a/src/stc/gen_iface.py b/src/stc/gen_iface.py index d332807..af2adbb 100755 --- a/src/stc/gen_iface.py +++ b/src/stc/gen_iface.py @@ -614,7 +614,12 @@ methodOverrideMap = { int %s(const wxString& text) { const wxWX2MBbuf buf = wx2stc(text); 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' : (0, @@ -913,6 +918,10 @@ methodOverrideMap = { """void* %s(int operation, void* pointer) { return (void*)(sptr_t)SendMsg(%s, operation, (sptr_t)pointer); """, 0), + + 'GetMultiPaste' : + (0, 0, 0, + ('Retrieve the effect of pasting when there are multiple selections.',)), '' : ('', 0, 0, 0), diff --git a/src/stc/stc.cpp b/src/stc/stc.cpp index 625694f..93e4266 100644 --- a/src/stc/stc.cpp +++ b/src/stc/stc.cpp @@ -1796,12 +1796,12 @@ int wxStyledTextCtrl::GetTargetEnd() const 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. -// 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 \). // 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) { const wxWX2MBbuf buf = wx2stc(text); @@ -2210,7 +2210,7 @@ void wxStyledTextCtrl::SetMultiPaste(int multiPaste) 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 { return SendMsg(2615, 0, 0); diff --git a/src/stc/stc.interface.h.in b/src/stc/stc.interface.h.in index 27a85df..0aae470 100644 --- a/src/stc/stc.interface.h.in +++ b/src/stc/stc.interface.h.in @@ -110,7 +110,7 @@ TOWRITE @endEventTable - @library{wxbase} + @library{wxstc} @category{stc} @see wxStyledTextEvent @@ -169,8 +169,8 @@ public: bold turns on bold italic turns on italics - fore:[name or #RRGGBB] sets the foreground colour - back:[name or #RRGGBB] sets the background colour + fore:[name or \#RRGGBB] sets the foreground colour + back:[name or \#RRGGBB] sets the background colour face:[facename] sets the font face name to use size:[num] sets the font size in points eol turns on eol filling @@ -398,7 +398,7 @@ public: @todo list styled text ctrl events. - @library{stc} + @library{wxstc} @category{events,stc} */ -- 2.7.4