Make storing non-trivial data in wxThreadSpecificInfo possible.

[wxWidgets.git] / interface / wx / help.h

diff --git a/interface/wx/help.h b/interface/wx/help.h
index 4e7cc954e159051f8e6e8deb84761e779abef666..88740c4c70f999879e63bff18571a72a4957c2e2 100644 (file)
--- a/interface/wx/help.h
+++ b/interface/wx/help.h
@@ -2,7 +2,6 @@
 // Name:        help.h
 // Purpose:     interface of wxHelpController
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -108,7 +107,7 @@ public:
           See also the help sample for notes on how to specify section numbers for
           various help file formats.
     */
-    virtual bool DisplaySection(int sectionNo) = 0;;
+    virtual bool DisplaySection(int sectionNo) = 0;
 
     /**
         Displays the text in a popup window, if possible.
@@ -197,13 +196,17 @@ 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 titleFormat 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,
+    virtual void SetFrameParameters(const wxString& titleFormat,
                                     const wxSize& size,
                                     const wxPoint& pos = wxDefaultPosition,
                                     bool newFrameEachTime = false);