]> git.saurik.com Git - wxWidgets.git/commitdiff
fix typo; distribute docs between Open() overloads for better rendering/better functi...
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Sun, 8 Mar 2009 12:05:00 +0000 (12:05 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Sun, 8 Mar 2009 12:05:00 +0000 (12:05 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59430 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/textfile.h

index 865814685de0ae2456966a741b1c2c8e7a361605..3299ab8ac6e886629b5f0774833b45f528dc510f 100644 (file)
@@ -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}
 
@@ -242,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
-        wxTextFile(const wxString&) 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.
 
@@ -253,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.