Attempt to fix wxHelpControllerBase::SetFrameParameters() documentation.

Don't use "%s" in the brief comment, "%" is apparently not allowed there.

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

diff --git a/interface/wx/help.h b/interface/wx/help.h
index 4e7cc954e159051f8e6e8deb84761e779abef666..1c15a76ec02d6fa1786cc44d3377ae65bb15f8df 100644 (file)
--- a/interface/wx/help.h
+++ b/interface/wx/help.h
@@ -197,11 +197,15 @@ public:
     virtual bool Quit() = 0;
 
     /**
-        For wxHtmlHelpController, the title is set (with %s indicating the
-        page title) and also the size and position of the frame if the frame is
-        already open. @a newFrameEachTime is ignored.
+        Set the parameters of the frame window.
+
+        For wxHtmlHelpController, @a title specifies the title string format
+        (with @c %s being replaced by the actual page title) and @a size and
+        @a position specify the geometry of the frame.
 
         For all other help controllers this function has no effect.
+
+        Finally, @a newFrameEachTime is always ignored currently.
     */
     virtual void SetFrameParameters(const wxString& title,
                                     const wxSize& size,