From 8175f069cd396213e2f6b9a05fda8591b2d2feb8 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 23 Jan 2018 16:08:46 -0500 Subject: [PATCH] Update documentation --- ec2n.h | 8 +++++++- ecp.h | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/ec2n.h b/ec2n.h index 95697926..6806444b 100644 --- a/ec2n.h +++ b/ec2n.h @@ -114,8 +114,14 @@ public: Element BERDecodeElement(BufferedTransformation &bt) const {return m_ec.BERDecodePoint(bt);} void DEREncodeElement(BufferedTransformation &bt, const Element &v) const {m_ec.DEREncodePoint(bt, v, false);} - // non-inherited + /// \brief Set the elliptic curve + /// \param ec ECP derived class + /// \details SetCurve() is not inherited void SetCurve(const EC2N &ec) {m_ec = ec;} + + /// \brief Get the elliptic curve + /// \returns EC2N curve + /// \details GetCurve() is not inherited const EC2N & GetCurve() const {return m_ec;} private: diff --git a/ecp.h b/ecp.h index 7b0a201f..834bef0d 100644 --- a/ecp.h +++ b/ecp.h @@ -128,12 +128,18 @@ public: Element BERDecodeElement(BufferedTransformation &bt) const {return m_ec->BERDecodePoint(bt);} void DEREncodeElement(BufferedTransformation &bt, const Element &v) const {m_ec->DEREncodePoint(bt, v, false);} - // non-inherited + /// \brief Set the elliptic curve + /// \param ec ECP derived class + /// \details SetCurve() is not inherited void SetCurve(const ECP &ec) { m_ec.reset(new ECP(ec, true)); m_ecOriginal = ec; } + + /// \brief Get the elliptic curve + /// \returns ECP curve + /// \details GetCurve() is not inherited const ECP & GetCurve() const {return *m_ecOriginal;} private: