From 0d3a51fd00c466da26b0e1963d6c582987c9ed22 Mon Sep 17 00:00:00 2001
From: Brad Hards <bradh@frogmouth.net>
Date: Mon, 3 Apr 2006 07:51:48 +0000
Subject: [PATCH] Fix up apidox errors, identified by Justin.

svn path=/trunk/kdesupport/qca/; revision=525897
---
 include/QtCrypto/qca_securemessage.h | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/include/QtCrypto/qca_securemessage.h b/include/QtCrypto/qca_securemessage.h
index cdd69d87..3d0450e6 100644
--- a/include/QtCrypto/qca_securemessage.h
+++ b/include/QtCrypto/qca_securemessage.h
@@ -416,11 +416,14 @@ namespace QCA
 		   signingObj.end();
 		   \endcode
 
-		   You then do either waitForFinished(), or use the
-		   finished() signal, to figure out when you can get
-		   the signature. For Detached format, you get the
-		   signature out using signature(); for other formats
-		   you get the signed message out using read().
+		   For Detached signatures, you won't get any results
+		   until the whole process is done - you either
+		   waitForFinished(), or use the finished() signal, to
+		   figure out when you can get the signature (using
+		   the signature() method, not using read()). For
+		   other formats, you can use the readyRead() signal
+		   to determine when there may be part of a signed
+		   message to read().
 
 		   \param m the mode that will be used to generate the
 		   signature
@@ -461,9 +464,9 @@ namespace QCA
 		/**
 		   Read the available data.
 
-		   \note For detached signatures, you get the message
-		   back using this method, and get the signature back
-		   using the signature() method.
+		   \note For detached signatures, you don't get
+		   anything back using this method. Use signature() to
+		   get the detached signature().
 		*/
 		QByteArray read();