Fixed a few typos in the password reader/writer source docu.

Sat, 03 Mar 2012 18:37:19 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 03 Mar 2012 18:37:19 +0100
changeset 1686
bd756cb42d5b
parent 1685
7640d5500966
child 1687
5efcb0cea376

Fixed a few typos in the password reader/writer source docu.

Documentation/Source/eric5.Helpviewer.Passwords.PasswordReader.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Helpviewer.Passwords.PasswordWriter.html file | annotate | diff | comparison | revisions
Helpviewer/Passwords/PasswordManager.py file | annotate | diff | comparison | revisions
Helpviewer/Passwords/PasswordReader.py file | annotate | diff | comparison | revisions
Helpviewer/Passwords/PasswordWriter.py file | annotate | diff | comparison | revisions
--- a/Documentation/Source/eric5.Helpviewer.Passwords.PasswordReader.html	Sat Mar 03 17:42:42 2012 +0100
+++ b/Documentation/Source/eric5.Helpviewer.Passwords.PasswordReader.html	Sat Mar 03 18:37:19 2012 +0100
@@ -77,7 +77,7 @@
 <td>Private method to skip over all unknown elements.</td>
 </tr><tr>
 <td><a href="#PasswordReader.read">read</a></td>
-<td>Public method to read an XBEL bookmark file.</td>
+<td>Public method to read a login data file.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -118,7 +118,7 @@
 <h4>PasswordReader.read</h4>
 <b>read</b>(<i>fileNameOrDevice</i>)
 <p>
-        Public method to read an XBEL bookmark file.
+        Public method to read a login data file.
 </p><dl>
 <dt><i>fileNameOrDevice</i></dt>
 <dd>
--- a/Documentation/Source/eric5.Helpviewer.Passwords.PasswordWriter.html	Sat Mar 03 17:42:42 2012 +0100
+++ b/Documentation/Source/eric5.Helpviewer.Passwords.PasswordWriter.html	Sat Mar 03 18:37:19 2012 +0100
@@ -102,6 +102,11 @@
 <dd>
 list of URLs to never store data for (list of strings)
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
 </dl><a NAME="PasswordWriter.__writeForms" ID="PasswordWriter.__writeForms"></a>
 <h4>PasswordWriter.__writeForms</h4>
 <b>__writeForms</b>(<i>forms</i>)
--- a/Helpviewer/Passwords/PasswordManager.py	Sat Mar 03 17:42:42 2012 +0100
+++ b/Helpviewer/Passwords/PasswordManager.py	Sat Mar 03 18:37:19 2012 +0100
@@ -165,7 +165,6 @@
                         .format(reader.lineNumber(),
                                 reader.columnNumber(),
                                 reader.errorString()))
-            pass
         
         self.__loaded = True
     
--- a/Helpviewer/Passwords/PasswordReader.py	Sat Mar 03 17:42:42 2012 +0100
+++ b/Helpviewer/Passwords/PasswordReader.py	Sat Mar 03 18:37:19 2012 +0100
@@ -24,7 +24,7 @@
     
     def read(self, fileNameOrDevice):
         """
-        Public method to read an XBEL bookmark file.
+        Public method to read a login data file.
         
         @param fileNameOrDevice name of the file to read (string)
             or reference to the device to read (QIODevice)
@@ -61,7 +61,7 @@
         """
         Private method to read and parse the login data file.
         """
-        if not self.isStartElement() and self.name() != "xbel":
+        if not self.isStartElement() and self.name() != "Password":
             return
         
         while not self.atEnd():
--- a/Helpviewer/Passwords/PasswordWriter.py	Sat Mar 03 17:42:42 2012 +0100
+++ b/Helpviewer/Passwords/PasswordWriter.py	Sat Mar 03 18:37:19 2012 +0100
@@ -49,6 +49,7 @@
         @param logins dictionary with login data (user name, password)
         @param forms list of forms data (list of LoginForm)
         @param nevers list of URLs to never store data for (list of strings)
+        @return flag indicating success (boolean)
         """
         self.writeStartDocument()
         self.writeDTD("<!DOCTYPE passwords>")

eric ide

mercurial