More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtr...

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

diff --git a/interface/html/helpctrl.h b/interface/html/helpctrl.h
index a605e3fa83b69a106dd8faacab9e08d0acbc4e79..ee3869a63bfe2ef42da2c955bf983784bbdb163e 100644 (file)
--- a/interface/html/helpctrl.h
+++ b/interface/html/helpctrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpctrl.h
-// Purpose:     documentation for wxHtmlHelpController class
+// Purpose:     interface of wxHtmlHelpController
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -24,7 +24,7 @@
 
     wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as
     its
-    native format. The file format is described here.
+    native format. The file format is described here().
     Have a look at docs/html/ directory where sample project files are stored.
 
     You can use Tex2RTF to produce these files when generating HTML, if you set @b
@@ -35,8 +35,7 @@
     @library{wxhtml}
     @category{help}
 
-    @seealso
-    @ref overview_wxhelpcontroller "Information about wxBestHelpController",
+    @see @ref overview_wxhelpcontroller "Information about wxBestHelpController",
     wxHtmlHelpFrame, wxHtmlHelpDialog, wxHtmlHelpWindow, wxHtmlModalHelp
 */
 class wxHtmlHelpController
@@ -46,15 +45,14 @@ public:
         Constructor.
     */
     wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE,
-                         wxWindow* parentWindow = @NULL);
+                         wxWindow* parentWindow = NULL);
 
     //@{
     /**
         Adds book (@ref overview_helpformat ".hhp file" - HTML Help Workshop project
         file) into the list of loaded books.
         This must be called at least once before displaying  any help.
-        
-        @e bookFile or @e bookUrl  may be either .hhp file or ZIP archive
+        @a bookFile or @a bookUrl  may be either .hhp file or ZIP archive
         that contains arbitrary number of .hhp files in
         top-level directory. This ZIP archive must have .zip or .htb extension
         (the latter stands for "HTML book"). In other words, @c
@@ -62,15 +60,13 @@ public:
         is possible and is the recommended way.
         
         @param showWaitMsg
-        If @true then a decoration-less window with progress message is displayed.
-        
+            If @true then a decoration-less window with progress message is displayed.
         @param bookFile
-        Help book filename. It is recommended to use this prototype
-        instead of the one taking URL, because it is less error-prone.
-        
+            Help book filename. It is recommended to use this prototype
+            instead of the one taking URL, because it is less error-prone.
         @param bookUrl
-        Help book URL (note that syntax of filename and URL is
-        different on most platforms)
+            Help book URL (note that syntax of filename and URL is
+            different on most platforms)
     */
     bool AddBook(const wxFileName& bookFile, bool showWaitMsg);
     bool AddBook(const wxString& bookUrl, bool showWaitMsg);
@@ -81,13 +77,13 @@ public:
         wxHF_DIALOG style, the controller
         uses a different dialog.
     */
-    virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData * data);
+    virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData* data);
 
     /**
         This protected virtual method may be overridden so that the controller
         uses a different frame.
     */
-    virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData * data);
+    virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData* data);
 
     //@{
     /**
@@ -111,7 +107,6 @@ public:
         Displays help window, focuses search panel and starts searching.  Returns @true
         if the keyword was found. Optionally it searches through the index (mode =
         wxHELP_SEARCH_INDEX), default the content (mode = wxHELP_SEARCH_ALL).
-        
         @b Important: KeywordSearch searches only pages listed in .hhc file(s).
         You should list all pages in the contents file.
     */
@@ -130,7 +125,6 @@ public:
         forms are much faster to read. Default value is empty string (empty string means
         that no cached data are stored). Note that these files are @e not
         deleted when program exits.
-        
         Once created these cached files will be used in all subsequent executions
         of your application. If cached files become older than corresponding .hhp
         file (e.g. if you regenerate documentation) it will be refreshed.
@@ -144,13 +138,10 @@ public:
     void SetTitleFormat(const wxString& format);
 
     /**
-        Associates @e config object with the controller.
-        
+        Associates @a config object with the controller.
         If there is associated config object, wxHtmlHelpController automatically
         reads and writes settings (including wxHtmlWindow's settings) when needed.
-        
         The only thing you must do is create wxConfig object and call UseConfig.
-        
         If you do not use @e UseConfig, wxHtmlHelpController will use
         default wxConfig object if available (for details see
         wxConfigBase::Get and
@@ -167,6 +158,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlModalHelp
     @headerfile helpctrl.h wx/html/helpctrl.h
@@ -194,19 +186,17 @@ class wxHtmlModalHelp
 public:
     /**
         @param parent
-        is the parent of the dialog.
-        
+            is the parent of the dialog.
         @param helpFile
-        is the HTML help file to show.
-        
+            is the HTML help file to show.
         @param topic
-        is an optional topic. If this is empty, the help contents will be shown.
-        
+            is an optional topic. If this is empty, the help contents will be shown.
         @param style
-        is a combination of the flags described in the wxHtmlHelpController
+            is a combination of the flags described in the wxHtmlHelpController
         documentation.
     */
     wxHtmlModalHelp(wxWindow* parent, const wxString& helpFile,
                     const wxString& topic = wxEmptyString,
                     int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL);
 };
+