mac paths updated

[wxWidgets.git] / interface / html / helpfrm.h

diff --git a/interface/html/helpfrm.h b/interface/html/helpfrm.h
index d9a0f7ce496b6e7ec69d796ba067fb7451081b78..90d084eb5b7a4c0eeaf99bfe16d8363e4528f658 100644 (file)
--- a/interface/html/helpfrm.h
+++ b/interface/html/helpfrm.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpfrm.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpfrm.h

-// Purpose:     documentation for wxHtmlHelpFrame class
+// Purpose:     interface of wxHtmlHelpFrame

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,12 +9,12 @@
 /**
     @class wxHtmlHelpFrame
     @headerfile helpfrm.h wx/html/helpfrm.h
 /**
     @class wxHtmlHelpFrame
     @headerfile helpfrm.h wx/html/helpfrm.h

-    
-    This class is used by wxHtmlHelpController 
+
+    This class is used by wxHtmlHelpController

     to display help.
     It is an internal class and should not be used directly - except for the case
     when you're writing your own HTML help controller.
     to display help.
     It is an internal class and should not be used directly - except for the case
     when you're writing your own HTML help controller.

-    
+

     @library{wxhtml}
     @category{FIXME}
 */
     @library{wxhtml}
     @category{FIXME}
 */


@@ -26,21 +26,20 @@ public:
         Constructor. For the values of @e style, please see the documentation for
         wxHtmlHelpController.
     */
         Constructor. For the values of @e style, please see the documentation for
         wxHtmlHelpController.
     */

-    wxHtmlHelpFrame(wxHtmlHelpData* data = @NULL);
-        wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
-                        const wxString& title = wxEmptyString,
-                        int style = wxHF_DEFAULT_STYLE,
-                        wxHtmlHelpData* data = @NULL);
+    wxHtmlHelpFrame(wxHtmlHelpData* data = NULL);
+    wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
+                    const wxString& title = wxEmptyString,
+                    int style = wxHF_DEFAULT_STYLE,
+                    wxHtmlHelpData* data = NULL);

     //@}
 
     /**
         You may override this virtual method to add more buttons to the help window's
     //@}
 
     /**
         You may override this virtual method to add more buttons to the help window's

-        toolbar. @e toolBar is a pointer to the toolbar and @e style is the style
+        toolbar. @a toolBar is a pointer to the toolbar and @a style is the style

         flag as passed to the Create method.
         flag as passed to the Create method.

-        

         wxToolBar::Realize is called immediately after returning from this function.
     */
         wxToolBar::Realize is called immediately after returning from this function.
     */

-    virtual void AddToolbarButtons(wxToolBar * toolBar, int style);
+    virtual void AddToolbarButtons(wxToolBar* toolBar, int style);

 
     /**
         Creates the frame. See @ref wxhtmlhelpframe() "the constructor"
 
     /**
         Creates the frame. See @ref wxhtmlhelpframe() "the constructor"


@@ -53,7 +52,7 @@ public:
     /**
         Returns the help controller associated with the frame.
     */
     /**
         Returns the help controller associated with the frame.
     */

-    wxHtmlHelpController* GetController();
+    wxHtmlHelpController* GetController() const;

 
     /**
         Reads the user's settings for this frame see
 
     /**
         Reads the user's settings for this frame see


@@ -68,7 +67,7 @@ public:
     void SetController(wxHtmlHelpController* contoller);
 
     /**
     void SetController(wxHtmlHelpController* contoller);
 
     /**

-        Sets the frame's title format. @e format must contain exactly one "%s"
+        Sets the frame's title format. @a format must contain exactly one "%s"

         (it will be replaced by the page title).
     */
     void SetTitleFormat(const wxString& format);
         (it will be replaced by the page title).
     */
     void SetTitleFormat(const wxString& format);


@@ -80,3 +79,4 @@ public:
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 };
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 };

+