]> git.saurik.com Git - wxWidgets.git/commitdiff
Fix wxTextFile::GetLine() documentation.
authorVadim Zeitlin <vadim@wxwidgets.org>
Mon, 2 Apr 2012 16:07:34 +0000 (16:07 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Mon, 2 Apr 2012 16:07:34 +0000 (16:07 +0000)
Document both const and non-const overloads of this method instead of having
some strange (and non-existent) chimera of the two.

Closes #14171.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71077 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/textfile.h

index 02bd50d0b931462ec3405fc7c9849e763765fce7..0cee089cb323c43bc92907ba49b2b9ba0f31c053 100644 (file)
@@ -190,10 +190,14 @@ public:
     /**
         Retrieves the line number @a n from the file.
 
-        The returned line may be modified but you shouldn't add line terminator
-        at the end - this will be done by wxTextFile.
+        The returned line may be modified when non-const method is used but you
+        shouldn't add line terminator at the end -- this will be done by
+        wxTextFile itself.
     */
-    wxString& GetLine(size_t n) const;
+    //@{
+    wxString& GetLine(size_t n);
+    const wxString& GetLine(size_t n) const;
+    //@}
 
     /**
         Get the number of lines in the file.