Fix html documentation warnings.

[wxWidgets.git] / interface / wx / file.h

diff --git a/interface/wx/file.h b/interface/wx/file.h
index 9c01ebdd7d6f9e2e9228d0140ff8f67cbb59a54f..8eeab558c57d02aa110de78d4de886c604d1cd96 100644 (file)
--- a/interface/wx/file.h
+++ b/interface/wx/file.h
@@ -2,7 +2,6 @@
 // Name:        file.h
 // Purpose:     interface of wxTempFile, wxFile
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -372,6 +371,23 @@ public:
     */
     ssize_t Read(void* buffer, size_t count);
 
+    /**
+        Reads the entire contents of the file into a string.
+
+        @param str
+            Non-@NULL pointer to a string to read data into.
+        @param conv
+            Conversion object to use in Unicode build; by default supposes
+            that file contents is encoded in UTF-8 but falls back to the
+            current locale encoding (or Latin-1 if it is UTF-8 too) if it is
+            not.
+
+        @return @true if file was read successfully, @false otherwise.
+
+        @since 2.9.5
+    */
+    bool ReadAll(wxString* str, const wxMBConv& conv = wxConvAuto());
+
     /**
         Seeks to the specified position.