From 317dfa4b7031ddaa70ddaf6ff98f20c2dfff5280 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 25 Sep 2012 13:50:07 +0000 Subject: [PATCH] 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 --- interface/wx/help.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/interface/wx/help.h b/interface/wx/help.h index 4e7cc954e1..1c15a76ec0 100644 --- 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,