From 07899488150b0e0e8ac714c014f9a6e245f911a7 Mon Sep 17 00:00:00 2001
From: Jeffrey Walton <noloader@gmail.com>
Date: Tue, 8 Dec 2020 00:15:19 -0500
Subject: Update documentation

---
 dsa.h | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'dsa.h')

diff --git a/dsa.h b/dsa.h
index 62837de9..01e5fecd 100644
--- a/dsa.h
+++ b/dsa.h
@@ -33,10 +33,15 @@ enum DSASignatureFormat {
 /// \param signature byte buffer for the existing signature encoding
 /// \param signatureLen the length of the existing signature encoding buffer
 /// \param fromFormat the source signature format
+/// \return the number of bytes written during encoding
 /// \details This function converts between these formats, and returns length
 ///  of signature in the target format. If <tt>toFormat == DSA_P1363</tt>, then
 ///  <tt>bufferSize</tt> must equal <tt>publicKey.SignatureLength()</tt> or
 ///  <tt>verifier.SignatureLength()</tt>.
+/// \details If the destination buffer is too small then the output of the
+///  encoded <tt>r</tt> and <tt>s</tt> will be truncated. Be sure to provide
+///  an adequately sized buffer and check the return value for the number of
+///  bytes written.
 /// \sa <A HREF="http://www.cryptopp.com/wiki/DSAConvertSignatureFormat">DSAConvertSignatureFormat</A>
 ///  on the Crypto++ wiki.
 /// \since Crypto++ 1.0
-- 
cgit v1.2.1