diff --git a/TODO b/TODO index dd3c77e8..b0eaf078 100644 --- a/TODO +++ b/TODO @@ -13,7 +13,6 @@ document all the stuff in qca_securemessage.h think about documenting the various providers (qcaprovider.h) Change Doxyfile config to capture whole API, and to generate Latex manual. - PKey has see-also references to uncallable functions (eg, toRSAPublicKey) * Considerations api: diff --git a/include/QtCrypto/qca_cert.h b/include/QtCrypto/qca_cert.h index 721fe245..7d60e60c 100644 --- a/include/QtCrypto/qca_cert.h +++ b/include/QtCrypto/qca_cert.h @@ -44,7 +44,11 @@ namespace QCA Certificate information types This enumeration provides the values that may appear in a - CertificateInfo key field. + CertificateInfo key field. These are from RFC3280 + (http://www.ietf.org/rfc/rfc3280.text) except where shown. + + \sa Certificate::subjectInfo() and Certificate::issuerInfo() + \sa CRL::issuerInfo() */ enum CertificateInfoType { @@ -55,10 +59,10 @@ namespace QCA Locality, ///< The locality (eg a shire, or part of a state) State, ///< The state within the country Country, ///< The country - URI, - DNS, - IPAddress, - XMPP + URI, ///< Uniform Resource Identifier + DNS, ///< DNS name + IPAddress, ///< IP address + XMPP ///< XMPP address (see http://www.ietf.org/rfc/rfc3920.txt) }; /** diff --git a/include/QtCrypto/qca_publickey.h b/include/QtCrypto/qca_publickey.h index 17832984..83379201 100644 --- a/include/QtCrypto/qca_publickey.h +++ b/include/QtCrypto/qca_publickey.h @@ -328,13 +328,12 @@ namespace QCA Interpret this key as a PublicKey \sa toRSAPublicKey(), toDSAPublicKey() and toDHPublicKey() + for protected forms of this call. */ PublicKey toPublicKey() const; /** Interpret this key as a PrivateKey - - \sa toRSAPrivateKey(), toDSAPrivateKey() and toDHPrivateKey() */ PrivateKey toPrivateKey() const; @@ -366,7 +365,7 @@ namespace QCA key was created as a DSA key, this function cannot turn it into an RSA key. - \sa toPublicKey(), toDSAPublcKey() and toDHPublicKey() + \sa toPublicKey() for the public version of this method */ RSAPublicKey toRSAPublicKey() const; @@ -377,7 +376,7 @@ namespace QCA key was created as a DSA key, this function cannot turn it into a RSA key. - \sa toPrivateKey(), toDSAPrivateKey() and toDHPrivateKey() + \sa toPrivateKey() for the public version of this method */ RSAPrivateKey toRSAPrivateKey() const; @@ -388,7 +387,7 @@ namespace QCA key was created as an RSA key, this function cannot turn it into a DSA key. - \sa toPublicKey(), toRSAPublcKey() and toDHPublicKey() + \sa toPublicKey() for the public version of this method */ DSAPublicKey toDSAPublicKey() const; @@ -399,7 +398,7 @@ namespace QCA key was created as an RSA key, this function cannot turn it into a DSA key. - \sa toPrivateKey(), toRSAPrivateKey() and toDHPrivateKey() + \sa toPrivateKey() for the public version of this method */ DSAPrivateKey toDSAPrivateKey() const; @@ -410,7 +409,7 @@ namespace QCA key was created as a DSA key, this function cannot turn it into a DH key. - \sa toPublicKey(), toRSAPublcKey() and toDSAPublicKey() + \sa toPublicKey() for the public version of this method */ DHPublicKey toDHPublicKey() const; @@ -421,7 +420,7 @@ namespace QCA key was created as a DSA key, this function cannot turn it into a DH key. - \sa toPrivateKey(), toDSAPrivateKey() and toRSAPrivateKey() + \sa toPrivateKey() for the public version of this method */ DHPrivateKey toDHPrivateKey() const; @@ -901,7 +900,7 @@ namespace QCA \param b if true, the key generator will be set to operate in blocking mode, otherwise it will operate in non-blocking mode - \sa blocking + \sa blocking() */ void setBlocking(bool b);