Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Utilities.crypto.__init__.html	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.crypto.__init__.html	Thu Dec 21 19:50:01 2023 +0100
@@ -91,9 +91,9 @@
 </p>
 <dl>
 
-<dt><i>newPassword</i></dt>
+<dt><i>newPassword</i> (str)</dt>
 <dd>
-new password to be used (string)
+new password to be used
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -108,25 +108,29 @@
 </p>
 <dl>
 
-<dt><i>edata</i></dt>
+<dt><i>edata</i> (str)</dt>
 <dd>
-hashed data to decrypt (string)
+hashed data to decrypt
 </dd>
-<dt><i>password</i></dt>
+<dt><i>password</i> (str)</dt>
 <dd>
-password to be used for decryption (string)
+password to be used for decryption
 </dd>
-<dt><i>keyLength</i></dt>
+<dt><i>keyLength</i> (int)</dt>
 <dd>
-length of the key to be generated for decryption
-        (16, 24 or 32)
+length of the key to be generated for decryption (16, 24 or 32)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-decrypted data (bytes) and flag indicating
-        success (boolean)
+decrypted data (bytes) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -141,30 +145,34 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (bytes)</dt>
 <dd>
-data to encrypt (bytes)
+data to encrypt
 </dd>
-<dt><i>password</i></dt>
+<dt><i>password</i> (str)</dt>
 <dd>
-password to be used for encryption (string)
+password to be used for encryption
 </dd>
-<dt><i>keyLength</i></dt>
+<dt><i>keyLength</i> (int)</dt>
 <dd>
-length of the key to be generated for encryption
-        (16, 24 or 32)
+length of the key to be generated for encryption (16, 24 or 32)
 </dd>
-<dt><i>hashIterations</i></dt>
+<dt><i>hashIterations</i> (int)</dt>
 <dd>
 number of hashes to be applied to the password for
-        generating the encryption key (integer)
+        generating the encryption key
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-encrypted data (bytes) and flag indicating
-        success (boolean)
+encrypted data (bytes) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -184,19 +192,25 @@
 </p>
 <dl>
 
-<dt><i>pw</i></dt>
+<dt><i>pw</i> (str)</dt>
 <dd>
-password to encode (string)
+password to encode
 </dd>
-<dt><i>encode</i></dt>
+<dt><i>encode</i> (bool)</dt>
 <dd>
-flag indicating an encode or decode function (boolean)
+flag indicating an encode or decode function
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-encoded or decoded password (string)
+encoded or decoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -211,15 +225,21 @@
 </p>
 <dl>
 
-<dt><i>epw</i></dt>
+<dt><i>epw</i> (str)</dt>
 <dd>
-encoded password to decode (string)
+encoded password to decode
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-decoded password (string)
+decoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -234,20 +254,25 @@
 </p>
 <dl>
 
-<dt><i>epw</i></dt>
+<dt><i>epw</i> (str)</dt>
 <dd>
-hashed password to decrypt (string)
+hashed password to decrypt
 </dd>
-<dt><i>mainPW</i></dt>
+<dt><i>mainPW</i> (str)</dt>
 <dd>
-password to be used for decryption (string)
+password to be used for decryption
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-decrypted password (string) and flag indicating
-        success (boolean)
+decrypted password (string) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -262,15 +287,21 @@
 </p>
 <dl>
 
-<dt><i>pw</i></dt>
+<dt><i>pw</i> (str)</dt>
 <dd>
-password to encode (string)
+password to encode
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-encoded password (string)
+encoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -285,20 +316,25 @@
 </p>
 <dl>
 
-<dt><i>pw</i></dt>
+<dt><i>pw</i> (str)</dt>
 <dd>
-password to encrypt (string)
+password to encrypt
 </dd>
-<dt><i>mainPW</i></dt>
+<dt><i>mainPW</i> (str)</dt>
 <dd>
-password to be used for encryption (string)
+password to be used for encryption
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-encrypted password (string) and flag indicating
-        success (boolean)
+encrypted password (string) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -316,23 +352,29 @@
 </p>
 <dl>
 
-<dt><i>epw</i></dt>
+<dt><i>epw</i> (str)</dt>
 <dd>
-encoded password to re-encode (string)
+encoded password to re-encode
 </dd>
-<dt><i>oldPassword</i></dt>
+<dt><i>oldPassword</i> (str)</dt>
 <dd>
-password used to encode (string)
+password used to encode
 </dd>
-<dt><i>newPassword</i></dt>
+<dt><i>newPassword</i> (str)</dt>
 <dd>
-new password to be used (string)
+new password to be used
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-encoded password (string)
+encoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -347,24 +389,29 @@
 </p>
 <dl>
 
-<dt><i>epw</i></dt>
+<dt><i>epw</i> (str)</dt>
 <dd>
-hashed password to re-encrypt (string)
+hashed password to re-encrypt
 </dd>
-<dt><i>oldPassword</i></dt>
+<dt><i>oldPassword</i> (str)</dt>
 <dd>
-password used to encrypt (string)
+password used to encrypt
 </dd>
-<dt><i>newPassword</i></dt>
+<dt><i>newPassword</i> (str)</dt>
 <dd>
-new password to be used (string)
+new password to be used
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-encrypted password (string) and flag indicating
-        success (boolean)
+encrypted password (string) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>