Update the API documentation to reflect the move

to SVN, and also to update a couple of the X.509
related classes.

svn path=/trunk/kdesupport/qca/; revision=414121

include/QtCrypto/qca.h

@@ -56,9 +56,9 @@
      - Secure byte arrays (QSecureArray)
      - Arbitrary precision integers (QBigInteger)
      - Random number generation (QCA::Random)
-     - SSL/TLS (ToDo)
+     - SSL/TLS (QCA::TLS)
      - X509 certificates (QCA::Certificate and QCA::CertificateCollection)
-     - Simple Authentication and Security Layer (SASL) (ToDo)
+     - Simple Authentication and Security Layer (SASL) (QCA::SASL)
      - RSA (QCA::RSAPrivateKey and QCA::RSAPublicKey)
      - DSA (QCA::DSAPrivateKey and QCA::DSAPublicKey)
      - Diffie-Hellman (QCA::DHPrivateKey and QCA::DHPublicKey)
@@ -114,17 +114,17 @@
 
    \subsection qca2code Current development
 
-   The latest version of the code is available from the KDE CVS
+   The latest version of the code is available from the KDE Subversion
    server (there is no formal release of the current version at this time). See
-   <a href="http://developer.kde.org/source/anoncvs.html">
-   http://developer.kde.org/source/anoncvs.html
+   <a href="http://developer.kde.org/source/anonsvn.html">
+   http://developer.kde.org/source/anonsvn.html
    </a> for general instructions. You do <i>not</i> need kdelibs or
    arts modules for %QCA - just pull down kdesupport/qca. The plugins
    are in the same tree. Naturally you will need %Qt properly set up
    and configured in order to build and use %QCA.
 
-   The CVS code can also be browsed
-   <a href="http://webcvs.kde.org/cgi-bin/cvsweb.cgi/kdesupport/qca/">
+   The Subversion code can also be browsed
+   <a href="http://websvn.kde.org/trunk/kdesupport/qca/">
    via the web</a>
 
    \subsection qca1code Previous versions

include/QtCrypto/qca_cert.h

@@ -464,13 +464,44 @@ namespace QCA
 		*/
 		bool operator!=(const Certificate &a) const;
 	};
+	
+	/**
+	   \class CertificateChain qca_cert.h QtCrypto
 
+	   A chain of related Certificates
+
+	   CertificateChain is a list (a QList) of certificates that are related by the 
+	   signature from one to another. If Certificate C signs Certificate B, and Certificate
+	   B signs Certificate A, then C, B and A form a chain.
+
+	   The normal use of a CertificateChain is from a end-user Certificate (called
+	   the primary, equivalent to QList::first()) though some intermediate Certificates
+	   to some other Certificate (QList::last()), which might
+	   be a root Certificate Authority, but does not need to be.
+
+	   You can build up the chain using normal QList operations, such as QList::append()
+
+	   \sa QCA::CertificateCollection for an alternative way to represent a group
+	   of Certificates that do not necessarily have a chained relationship.
+	*/
 	class QCA_EXPORT CertificateChain : public QList<Certificate>
 	{
 	public:
+		/**
+		   Create an empty certificate chain
+		*/
 		CertificateChain();
+
+		/**
+		   Create a certificate chain, starting at the specified certificate
+
+		   \param primary the end-user certificate that forms one end of the chain
+		*/
 		CertificateChain(const Certificate &primary);
 
+		/**
+		   Return the primary (end-user) Certificate
+		*/
 		const Certificate & primary() const;
 	};
 
@@ -478,6 +509,8 @@ namespace QCA
 	   \class CertificateRequest qca_cert.h QtCrypto
 
 	   Certificate Request
+
+	   A Certificate Request is a unsigned request for a Certificate
 	*/
 	class QCA_EXPORT CertificateRequest : public Algorithm
 	{
@@ -826,6 +859,12 @@ namespace QCA
 	   \class CertificateCollection qca_cert.h QtCrypto
 
 	   Bundle of Certificates and CRLs
+
+	   CertificateCollection provides a bundle of Certificates and Certificate Revocation
+	   Lists (CRLs), not necessarily related.
+
+	   \sa QCA::CertificateChain for a representation of a chain of Certificates related by
+	   signatures.
 	*/
 	class CertificateCollection
 	{
@@ -955,17 +994,58 @@ namespace QCA
 
 	/**
 	   \class CertificateAuthority qca_cert.h QtCrypto
+
+	   A %Certificate Authority is used to generate Certificates and
+	   %Certificate Revocation Lists (CRLs).
 	*/
 	class QCA_EXPORT CertificateAuthority : public Algorithm
 	{
 	public:
+		/**
+		   Create a new %Certificate Authority
+
+		   \param cert the CA certificate
+		   \param key the private key associated with the CA certificate
+		   \param provider the provider to use, if a specific provider is required
+		*/
 		CertificateAuthority(const Certificate &cert, const PrivateKey &key, const QString &provider);
 
 		Certificate certificate() const;
 
+		/**
+		   Create a new Certificate by signing the provider CertificateRequest
+
+		   \param req the CertificateRequest to sign
+		   \param notValidAfter the last date that the Certificate will be valid
+		*/
 		Certificate signRequest(const CertificateRequest &req, const QDateTime &notValidAfter) const;
+
+		/**
+		   Create a new Certificate
+
+		   \param key the Public Key to use to create the Certificate
+		   \param opts the options to use for the new Certificate
+		*/
 		Certificate createCertificate(const PublicKey &key, const CertificateOptions &opts) const;
+
+		/**
+		   Create a new Certificate Revocation List (CRL)
+
+		   \param nextUpdate the date that the CRL will be updated
+
+		   \return an empty CRL
+		*/
 		CRL createCRL(const QDateTime &nextUpdate) const;
+
+		/**
+		   Update the CRL to include new entries
+
+		   \param crl the CRL to update
+		   \param entries the entries to add to the CRL
+		   \param nextUpdate the date that this CRL will be updated
+
+		   \return the update CRL
+		*/
 		CRL updateCRL(const CRL &crl, const QList<CRLEntry> &entries, const QDateTime &nextUpdate) const;
 	};