undo the last change as it results in buildbot configuration error

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

diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h
index eec73ae0713b6825c47f9cde6d1560804dedea3c..3299ab8ac6e886629b5f0774833b45f528dc510f 100644 (file)
--- a/interface/wx/textfile.h
+++ b/interface/wx/textfile.h
@@ -54,10 +54,9 @@ enum wxTextFileType
       wxTextFile::Clear resets the file to empty.
     - Save your changes: notice that the changes you make to the file will @b not be
       saved automatically; calling wxTextFile::Close or doing nothing discards them!
       wxTextFile::Clear resets the file to empty.
     - Save your changes: notice that the changes you make to the file will @b not be
       saved automatically; calling wxTextFile::Close or doing nothing discards them!

-      To save the changes you must explicitly callwxTextFile::Write - here, you may
+      To save the changes you must explicitly call wxTextFile::Write - here, you may

       also change the line termination type if you wish.
 
       also change the line termination type if you wish.
 

-

     @library{wxbase}
     @category{file}
 
     @library{wxbase}
     @category{file}
 


@@ -99,16 +98,22 @@ public:
     */
     bool Close();
 
     */
     bool Close();
 

-    //@{

     /**
     /**

-        Creates the file with the given name or the name which was given in the
-        @ref wxTextFile() constructor. The array of file lines is initially empty.
+        Creates the file with the name which was given in the
+        wxTextFile(const wxString&) constructor.
+        The array of file lines is initially empty.

 
         It will fail if the file already exists, Open() should be used in this case.
     */
 
         It will fail if the file already exists, Open() should be used in this case.
     */

-    bool Create() const;
-    bool Create(const wxString& strFile) const;
-    //@}
+    bool Create();
+
+    /**
+        Creates the file with the given name.
+        The array of file lines is initially empty.
+
+        It will fail if the file already exists, Open() should be used in this case.
+    */
+    bool Create(const wxString& strFile);

 
     /**
         Returns @true if the current line is the last one.
 
     /**
         Returns @true if the current line is the last one.


@@ -139,7 +144,7 @@ public:
         compiling with the Apple Developer Tools) and @c wxTextFileType_Mac under
         Mac OS (including Mac OS X when compiling with CodeWarrior).
     */
         compiling with the Apple Developer Tools) and @c wxTextFileType_Mac under
         Mac OS (including Mac OS X when compiling with CodeWarrior).
     */

-    static const char* GetEOL(wxTextFileType type = typeDefault) const;
+    static const wxChar* GetEOL(wxTextFileType type = wxTextBuffer::typeDefault);

 
     /**
         This method together with GetNextLine() allows more "iterator-like"
 
     /**
         This method together with GetNextLine() allows more "iterator-like"


@@ -236,10 +241,9 @@ public:
     */
     bool IsOpened() const;
 
     */
     bool IsOpened() const;
 

-    //@{

     /**
     /**

-        Open() opens the file with the given name or the name which was given in the
-        @ref wxTextFile() constructor and also loads file in memory on success.
+        Opens the file with the name which was given in the wxTextFile(const wxString&)
+        constructor and also loads file in memory on success.

 
         It will fail if the file does not exist, Create() should be used in this case.
 
 
         It will fail if the file does not exist, Create() should be used in this case.
 


@@ -247,8 +251,16 @@ public:
         it is used to convert the file to wide character representation.
     */
     bool Open(const wxMBConv& conv = wxConvAuto()) const;
         it is used to convert the file to wide character representation.
     */
     bool Open(const wxMBConv& conv = wxConvAuto()) const;

+
+    /**
+        Opens the file with the given name and also loads file in memory on success.
+
+        It will fail if the file does not exist, Create() should be used in this case.
+
+        The @a conv argument is only meaningful in Unicode build of wxWidgets when
+        it is used to convert the file to wide character representation.
+    */

     bool Open(const wxString& strFile, const wxMBConv& conv = wxConvAuto()) const;
     bool Open(const wxString& strFile, const wxMBConv& conv = wxConvAuto()) const;

-    //@}

 
     /**
         Delete line number @a n from the file.
 
     /**
         Delete line number @a n from the file.