QuasarApp/qca
4
0
Fork 0
mirror of https://github.com/QuasarApp/qca.git synced 2025-04-29 04:54:31 +00:00
Code Issues Projects Releases Wiki Activity

Minor docs fix

Browse Source
This commit is contained in:
Mark Nalimov 2021-05-24 11:01:43 +03:00
parent ecdd0538dd
commit 797b430540
5 changed files with 18 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/QtCrypto/qca_basic.h
View File

@ -115,7 +115,7 @@ public:
Provide a random character (byte)
This is the normal way of obtaining a single random char
(ie. 8 bit byte), as shown below:
(i.e. 8 bit byte), as shown below:
\code
myRandomChar = QCA::Random::randomChar();
\endcode

18
include/QtCrypto/qca_cert.h
View File

@ -1023,9 +1023,9 @@ CertificateInfoOrdered info = cert.subjectInfoOrdered();
PublicKey subjectPublicKey() const;
/**
Test if the Certificate is valid as a Certificate Authority
Test if the Certificate is valid as a %Certificate Authority
\return true if the Certificate is valid as a Certificate Authority
\return true if the Certificate is valid as a %Certificate Authority
*/
bool isCA() const;
@ -1212,7 +1212,7 @@ private:
The normal use of a CertificateChain is from a end-user Certificate (called
the primary, equivalent to QList::first()) through some intermediate
Certificates to some other Certificate (QList::last()), which might be a
root Certificate Authority, but does not need to be.
root %Certificate Authority, but does not need to be.
You can build up the chain using normal QList operations, such as
QList::append().
@ -1431,7 +1431,7 @@ public:
PublicKey subjectPublicKey() const;
/**
Test if this Certificate Request is for a Certificate Authority
Test if this %Certificate Request is for a %Certificate Authority
certificate
\note this only applies to PKCS#10 format certificate requests
@ -1439,7 +1439,7 @@ public:
bool isCA() const;
/**
The path limit for the certificate in this Certificate Request
The path limit for the certificate in this %Certificate Request
\note this only applies to PKCS#10 format certificate requests
*/
@ -1476,14 +1476,14 @@ public:
}
/**
Export the Certificate Request into a DER format
Export the %Certificate Request into a DER format
\note this only applies to PKCS#10 format certificate requests
*/
QByteArray toDER() const;
/**
Export the Certificate Request into a PEM format
Export the %Certificate Request into a PEM format
\note this only applies to PKCS#10 format certificate requests
*/
@ -1760,7 +1760,7 @@ public:
/**
Test if the CRL is empty
\return true if the CRL is entry, otherwise return false
\return true if the CRL is empty, otherwise return false
*/
bool isNull() const;
@ -2129,7 +2129,7 @@ public:
Certificate createCertificate(const PublicKey &key, const CertificateOptions &opts) const;
/**
Create a new Certificate Revocation List (CRL)
Create a new %Certificate Revocation List (CRL)
\param nextUpdate the date that the CRL will be updated

10
include/QtCrypto/qca_core.h
View File

@ -1310,26 +1310,26 @@ class QCA_EXPORT InitializationVector : public SecureArray
{
public:
/**
Construct an empty (zero length) initisation vector
Construct an empty (zero length) initialization vector
*/
InitializationVector();
/**
Construct an initialisation vector of the specified size
Construct an initialization vector of the specified size
\param size the length of the initialisation vector, in bytes
\param size the length of the initialization vector, in bytes
*/
InitializationVector(int size);
/**
Construct an initialisation vector from a provided byte array
Construct an initialization vector from a provided byte array
\param a the byte array to copy
*/
InitializationVector(const SecureArray &a);
/**
Construct an initialisation vector from a provided byte array
Construct an initialization vector from a provided byte array
\param a the byte array to copy
*/

5
include/QtCrypto/qca_support.h
View File

@ -266,9 +266,6 @@ int x = thread->call(thread->counter, "value").toInt();
delete thread;
\endcode
Do you see a mutex anywhere? I didn't think so.<br>
---
Even without the call() function, SyncThread is still very useful
for preparing objects in another thread, which you can then
QObject::connect() to and use signals and slots like normal.
@ -434,7 +431,7 @@ public:
Q_SIGNALS:
/**
The changed signal is emitted when the directory is
changed (e.g. modified by addition or deletion of a
changed (e.g.\ modified by addition or deletion of a
file within the directory, or the deletion of the
directory)
*/

4
include/QtCrypto/qcaprovider.h
View File

@ -379,7 +379,7 @@ public:
\param secret the secret part (typically password)
\param salt the salt / initialization vector
\param keyLength the length of the key to be produced
\param iterationCount the number of iterations of the derivation algorith,
\param iterationCount the number of iterations of the derivation algorithm
*/
virtual SymmetricKey makeKey(const SecureArray & secret,
const InitializationVector &salt,
@ -393,7 +393,7 @@ public:
\param salt the salt / initialization vector
\param keyLength the length of the key to be produced
\param msecInterval the maximum time to compute the key, in milliseconds
\param iterationCount a pointer to store the number of iterations of the derivation algorithm,
\param iterationCount a pointer to store the number of iterations of the derivation algorithm
*/
virtual SymmetricKey makeKey(const SecureArray & secret,
const InitializationVector &salt,