Document wxHelpControllerBase so the type can be used in Phoenix

[wxWidgets.git] / interface / wx / html / htmlfilt.h
diff --git a/interface/wx/html/htmlfilt.h b/interface/wx/html/htmlfilt.h

index 94cd977d33e3be79060c61960595a084628d25d9..d407a857ba8552180bd61922d4421bb22130b1e9 100644 (file)
--- a/interface/wx/html/htmlfilt.h
+++ b/interface/wx/html/htmlfilt.h
@@ -3,7 +3,7 @@
  // Purpose:     interface of wxHtmlFilter
  // Author:      wxWidgets team
  // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
  /////////////////////////////////////////////////////////////////////////////
  
  /**
@@ -13,9 +13,9 @@
      It allows you to read and display files of different file formats.
  
      @library{wxhtml}
-    @category{FIXME}
+    @category{html}
  
-    @see Overview()
+    @see @ref overview_html_filters
  */
  class wxHtmlFilter : public wxObject
  {
@@ -28,13 +28,26 @@ public:
      /**
          Returns @true if this filter is capable of reading file @e file.
          Example:
+        @code
+        bool MyFilter::CanRead(const wxFSFile& file)
+        {
+            return (file.GetMimeType() == "application/x-ugh");
+        }
+        @endcode
      */
-    bool CanRead(const wxFSFile& file);
+    virtual bool CanRead(const wxFSFile& file) const = 0;
  
      /**
          Reads the file and returns string with HTML document.
          Example:
+        @code
+        wxString MyImgFilter::ReadFile(const wxFSFile& file)
+        {
+            return "<html><body><img src=\"" + file.GetLocation() +
+                   "\"></body></html>";
+        }
+        @endcode
      */
-    wxString ReadFile(const wxFSFile& file);
+    virtual wxString ReadFile(const wxFSFile& file) const = 0;
  };