regenerated headers to remove @seealso in favour of @see; fixed links to global functions/macros; converted \since latex macros into @wxsince commands; changed headers purpose from 'documentation for' to 'interface of'

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

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
@@ -159,6 +158,7 @@ public:
 };
 
 
+
 /**
     @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);
 };
+

interface/html/helpdata.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpdata.h
-// Purpose:     documentation for wxHtmlHelpData class
+// Purpose:     interface of wxHtmlHelpData
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -66,3 +66,4 @@ public:
     */
     void SetTempDir(const wxString& path);
 };
+

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
@@ -79,3 +79,4 @@ public:
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 };
+

interface/html/helpfrm.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpfrm.h
-// Purpose:     documentation for wxHtmlHelpFrame class
+// Purpose:     interface of wxHtmlHelpFrame
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -79,3 +79,4 @@ public:
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 };
+

interface/html/helpwnd.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpwnd.h
-// Purpose:     documentation for wxHtmlHelpWindow class
+// Purpose:     interface of wxHtmlHelpWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -165,3 +165,4 @@ public:
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 };
+

interface/html/htmlcell.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmlcell.h
-// Purpose:     documentation for wxHtmlColourCell class
+// Purpose:     interface of wxHtmlColourCell
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -53,6 +53,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlWidgetCell
     @headerfile htmlcell.h wx/html/htmlcell.h
@@ -86,6 +87,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlCell
     @headerfile htmlcell.h wx/html/htmlcell.h
@@ -102,8 +104,7 @@ public:
     @library{wxhtml}
     @category{FIXME}
 
-    @seealso
-    @ref overview_cells "Cells Overview", wxHtmlContainerCell
+    @see @ref overview_cells "Cells Overview", wxHtmlContainerCell
 */
 class wxHtmlCell : public wxObject
 {
@@ -312,6 +313,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlContainerCell
     @headerfile htmlcell.h wx/html/htmlcell.h
@@ -322,8 +324,7 @@ public:
     @library{wxhtml}
     @category{FIXME}
 
-    @seealso
-    @ref overview_cells "Cells Overview"
+    @see @ref overview_cells "Cells Overview"
 */
 class wxHtmlContainerCell : public wxHtmlCell
 {
@@ -676,6 +677,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlLinkInfo
     @headerfile htmlcell.h wx/html/htmlcell.h
@@ -727,3 +729,4 @@ public:
     */
     wxString GetTarget();
 };
+

interface/html/htmlfilt.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmlfilt.h
-// Purpose:     documentation for wxHtmlFilter class
+// Purpose:     interface of wxHtmlFilter
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -16,8 +16,7 @@
     @library{wxhtml}
     @category{FIXME}
 
-    @seealso
-    Overview
+    @see Overview()
 */
 class wxHtmlFilter : public wxObject
 {
@@ -39,3 +38,4 @@ public:
     */
     wxString ReadFile(const wxFSFile& file);
 };
+

interface/html/htmlpars.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmlpars.h
-// Purpose:     documentation for wxHtmlTagHandler class
+// Purpose:     interface of wxHtmlTagHandler
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -14,8 +14,7 @@
     @library{wxhtml}
     @category{html}
 
-    @seealso
-    Overview, wxHtmlTag
+    @see Overview(), wxHtmlTag
 */
 class wxHtmlTagHandler : public wxObject
 {
@@ -63,6 +62,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlParser
     @headerfile htmlpars.h wx/html/htmlpars.h
@@ -88,8 +88,7 @@ public:
     @library{wxhtml}
     @category{html}
 
-    @seealso
-    @ref overview_cells "Cells Overview", @ref overview_handlers "Tag Handlers
+    @see @ref overview_cells "Cells Overview", @ref overview_handlers "Tag Handlers
     Overview", wxHtmlTag
 */
 class wxHtmlParser
@@ -268,3 +267,4 @@ public:
     */
     void StopParsing();
 };
+

interface/html/htmltag.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmltag.h
-// Purpose:     documentation for wxHtmlTag class
+// Purpose:     interface of wxHtmlTag
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -127,3 +127,4 @@ public:
     wxString ScanParam(const wxString& par, const wxChar* format,
                        void* value) const;
 };
+

interface/html/htmlwin.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmlwin.h
-// Purpose:     documentation for wxHtmlWindow class
+// Purpose:     interface of wxHtmlWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -36,8 +36,7 @@
     @library{wxhtml}
     @category{html}
 
-    @seealso
-    wxHtmlLinkEvent, wxHtmlCellEvent
+    @see wxHtmlLinkEvent, wxHtmlCellEvent
 */
 class wxHtmlWindow : public wxScrolledWindow
 {
@@ -395,6 +394,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlLinkEvent
     @headerfile htmlwin.h wx/html/htmlwin.h
@@ -420,6 +420,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlCellEvent
     @headerfile htmlwin.h wx/html/htmlwin.h
@@ -465,3 +466,4 @@ public:
     */
     bool SetLinkClicked(bool linkclicked);
 };
+

interface/html/htmprint.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmprint.h
-// Purpose:     documentation for wxHtmlDCRenderer class
+// Purpose:     interface of wxHtmlDCRenderer
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -93,6 +93,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlEasyPrinting
     @headerfile htmprint.h wx/html/htmprint.h
@@ -232,6 +233,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlPrintout
     @headerfile htmprint.h wx/html/htmprint.h
@@ -325,3 +327,4 @@ public:
                     float right = 25.2,
                     float spaces = 5);
 };
+

interface/html/winpars.h

@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/winpars.h
-// Purpose:     documentation for wxHtmlTagsModule class
+// Purpose:     interface of wxHtmlTagsModule
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -17,8 +17,8 @@
     @library{wxhtml}
     @category{FIXME}
 
-    @seealso
-    @ref overview_handlers "Tag Handlers", wxHtmlTagHandler, wxHtmlWinTagHandler,
+    @see @ref overview_handlers "Tag Handlers", wxHtmlTagHandler,
+    wxHtmlWinTagHandler,
 */
 class wxHtmlTagsModule : public wxModule
 {
@@ -36,6 +36,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlWinTagHandler
     @headerfile winpars.h wx/html/winpars.h
@@ -60,6 +61,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlWinParser
     @headerfile winpars.h wx/html/winpars.h
@@ -72,8 +74,7 @@ public:
     @library{wxhtml}
     @category{html}
 
-    @seealso
-    @ref overview_handlers "Handlers overview"
+    @see @ref overview_handlers "Handlers overview"
 */
 class wxHtmlWinParser : public wxHtmlParser
 {
@@ -90,13 +91,13 @@ public:
     //@}
 
     /**
-        Adds module to the list of wxHtmlWinParser tag handler.
+        Adds module() to the list of wxHtmlWinParser tag handler.
     */
     static void AddModule(wxHtmlTagsModule module);
 
     /**
         Closes the container, sets actual container to the parent one
-        and returns pointer to it (see Overview).
+        and returns pointer to it (see Overview()).
     */
     wxHtmlContainerCell* CloseContainer();
 
@@ -139,7 +140,7 @@ public:
     int GetCharWidth() const;
 
     /**
-        Returns pointer to the currently opened container (see Overview).
+        Returns pointer to the currently opened container (see Overview()).
         Common use:
     */
     wxHtmlContainerCell* GetContainer() const;
@@ -218,7 +219,7 @@ public:
     wxHtmlWindow* GetWindow();
 
     /**
-        Opens new container and returns pointer to it (see Overview).
+        Opens new container and returns pointer to it (see Overview()).
     */
     wxHtmlContainerCell* OpenContainer();
 
@@ -310,3 +311,4 @@ public:
     */
     void SetLinkColor(const wxColour& clr);
 };
+