Intial review of calctrl.h.

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

diff --git a/interface/html/helpdlg.h b/interface/html/helpdlg.h
index 43768d9694dc7a4b876efe8090e5dfcb9c69a605..3b689e837d074e32397d572095e3086b0eacd293 100644 (file)
--- a/interface/html/helpdlg.h
+++ b/interface/html/helpdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpdlg.h
-// Purpose:     documentation for wxHtmlHelpDialog class
+// Purpose:     interface of wxHtmlHelpDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,12 +9,12 @@
 /**
     @class wxHtmlHelpDialog
     @headerfile helpdlg.h wx/html/helpdlg.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.
-    
+
     @library{wxhtml}
     @category{FIXME}
 */
@@ -26,21 +26,20 @@ public:
         Constructor. For the values of @e style, please see the documentation for
         wxHtmlHelpController.
     */
-    wxHtmlHelpDialog(wxHtmlHelpData* data = @NULL);
-        wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
-                         const wxString& title = wxEmptyString,
-                         int style = wxHF_DEFAULT_STYLE,
-                         wxHtmlHelpData* data = @NULL);
+    wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
+    wxHtmlHelpDialog(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
-        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.
-        
         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 dialog. See @ref wxhtmlhelpdialog() "the constructor"
@@ -53,7 +52,7 @@ public:
     /**
         Returns the help controller associated with the dialog.
     */
-    wxHtmlHelpController* GetController();
+    wxHtmlHelpController* GetController() const;
 
     /**
         Reads the user's settings for this dialog see
@@ -68,7 +67,7 @@ public:
     void SetController(wxHtmlHelpController* contoller);
 
     /**
-        Sets the dialog's title format. @e format must contain exactly one "%s"
+        Sets the dialog's title format. @a format must contain exactly one "%s"
         (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);
 };
+