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 516455866fc92548f5a945b71242eb7b9f9afcbc..ee3869a63bfe2ef42da2c955bf983784bbdb163e 100644 (file)
--- a/interface/html/helpctrl.h
+++ b/interface/html/helpctrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpctrl.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpctrl.h

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

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // 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
 
     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
     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}
 
     @library{wxhtml}
     @category{help}
 

-    @seealso
-    @ref overview_wxhelpcontroller "Information about wxBestHelpController",
+    @see @ref overview_wxhelpcontroller "Information about wxBestHelpController",

     wxHtmlHelpFrame, wxHtmlHelpDialog, wxHtmlHelpWindow, wxHtmlModalHelp
 */
 class wxHtmlHelpController
     wxHtmlHelpFrame, wxHtmlHelpDialog, wxHtmlHelpWindow, wxHtmlModalHelp
 */
 class wxHtmlHelpController


@@ -159,6 +158,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxHtmlModalHelp
     @headerfile helpctrl.h wx/html/helpctrl.h
 /**
     @class wxHtmlModalHelp
     @headerfile helpctrl.h wx/html/helpctrl.h


@@ -199,3 +199,4 @@ public:
                     const wxString& topic = wxEmptyString,
                     int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL);
 };
                     const wxString& topic = wxEmptyString,
                     int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL);
 };

+