commit 150c4f62f18389cef133bd078f306cfd807b1551
author Manuel Pégourié-Gonnard <mpg@elzevir.fr> Fri Nov 21 09:14:52 2014 +0100
committer Manuel Pégourié-Gonnard <mpg@elzevir.fr> Thu Nov 27 17:44:45 2014 +0100
tree 48a04b8bef8b3211ce1f937b00facc9befe3bcc6
parent 3e9449350ca1a27b33a83287211e104cf51959a3

Clarify documentation a bit

include/polarssl/ecp.h

diff --git a/include/polarssl/ecp.h b/include/polarssl/ecp.h
index 9b83bc5..6dec5bd 100644
--- a/include/polarssl/ecp.h
+++ b/include/polarssl/ecp.h
@@ -413,6 +413,8 @@
  * \param buf       $(Start of input buffer)
  * \param len       Buffer length
  *
+ * \note            buf is updated to point right after the ECPoint on exit
+ *
  * \return          O if successful,
  *                  POLARSSL_ERR_MPI_XXX if initialization failed
  *                  POLARSSL_ERR_ECP_BAD_INPUT_DATA if input is invalid
@@ -479,6 +481,8 @@
  * \param buf       &(Start of input buffer)
  * \param len       Buffer length
  *
+ * \note            buf is updated to point right after ECParameters on exit
+ *
  * \return          O if successful,
  *                  POLARSSL_ERR_MPI_XXX if initialization failed
  *                  POLARSSL_ERR_ECP_BAD_INPUT_DATA if input is invalid