describe wxMemory* streams

[wxWidgets.git] / interface / wx / html / helpdata.h

diff --git a/interface/wx/html/helpdata.h b/interface/wx/html/helpdata.h
index f124c123a1fe360af06d43d2d109fc1a172b12c0..cf458f64ee447a89c8a70286b552f23e9dac2293 100644 (file)
--- a/interface/wx/html/helpdata.h
+++ b/interface/wx/html/helpdata.h
@@ -8,15 +8,15 @@
 
 /**
     @class wxHtmlHelpData
-    @headerfile helpdata.h wx/html/helpdata.h
 
-    This class is used by wxHtmlHelpController
-    and wxHtmlHelpFrame to access HTML help items.
+    This class is used by wxHtmlHelpController and wxHtmlHelpFrame to access HTML
+    help items.
+
     It is internal class and should not be used directly - except for the case
     you're writing your own HTML help controller.
 
     @library{wxhtml}
-    @category{FIXME}
+    @category{help,html}
 */
 class wxHtmlHelpData : public wxObject
 {
@@ -27,9 +27,12 @@ public:
     wxHtmlHelpData();
 
     /**
-        Adds new book. @e book is URL (not filename!) of HTML help project (hhp)
-        or ZIP file that contains arbitrary number of .hhp projects (this zip
-        file can have either .zip or .htb extension, htb stands for "html book").
+        Adds new book.
+
+        @a book_url is URL (not filename!) of HTML help project (hhp) or ZIP file
+        that contains arbitrary number of .hhp projects (this zip file can have
+        either .zip or .htb extension, htb stands for "html book").
+
         Returns success.
     */
     bool AddBook(const wxString& book_url);
@@ -47,20 +50,20 @@ public:
     /**
         Returns array with help books info.
     */
-    const wxHtmlBookRecArray GetBookRecArray();
+    const wxHtmlBookRecArray& GetBookRecArray() const;
 
     /**
         Returns reference to array with contents entries.
     */
-    const wxHtmlHelpDataItems GetContentsArray();
+    const wxHtmlHelpDataItems& GetContentsArray() const;
 
     /**
         Returns reference to array with index entries.
     */
-    const wxHtmlHelpDataItems GetIndexArray();
+    const wxHtmlHelpDataItems& GetIndexArray() const;
 
     /**
-        Sets temporary directory where binary cached versions of MS HTML Workshop
+        Sets the temporary directory where binary cached versions of MS HTML Workshop
         files will be stored. (This is turned off by default and you can enable
         this feature by setting non-empty temp dir.)
     */