diff options
| author | Jeffrey Walton <noloader@gmail.com> | 2018-12-25 10:54:42 -0500 |
|---|---|---|
| committer | Jeffrey Walton <noloader@gmail.com> | 2018-12-25 10:54:42 -0500 |
| commit | f981c86c69b9ee249b143791fe6fb9e2daf5dc5b (patch) | |
| tree | 2106f0df4211a0dbe6ee64e2ecaf06aae468b3b6 /xed25519.h | |
| parent | ba0dece8d9a75a7d1ae7a50d96f6255758aaf7a9 (diff) | |
| download | cryptopp-git-f981c86c69b9ee249b143791fe6fb9e2daf5dc5b.tar.gz | |
Update documentation
Diffstat (limited to 'xed25519.h')
| -rw-r--r-- | xed25519.h | 18 |
1 files changed, 9 insertions, 9 deletions
@@ -205,9 +205,9 @@ public: /// OID used by SSH, OIDs specified in draft-josefsson-pkix-newcurves,
/// and OIDs specified in draft-ietf-curdle-pkix.
/// \details By default BERDecodeAndCheckAlgorithmID() accepts an
- /// OID set by the user, ASN1::curve25519() and ASN1::X25519().
- /// ASN1::curve25519() is generic and says "this key is valid for
- /// curve25519 operations". ASN1::X25519() is specific and says
+ /// OID set by the user, <tt>ASN1::curve25519()</tt> and <tt>ASN1::X25519()</tt>.
+ /// <tt>ASN1::curve25519()</tt> is generic and says "this key is valid for
+ /// curve25519 operations". <tt>ASN1::X25519()</tt> is specific and says
/// "this key is valid for x25519 key exchange."
void BERDecodeAndCheckAlgorithmID(BufferedTransformation& bt);
@@ -391,9 +391,9 @@ struct ed25519PrivateKey : public PKCS8PrivateKey /// OID used by SSH, OIDs specified in draft-josefsson-pkix-newcurves,
/// and OIDs specified in draft-ietf-curdle-pkix.
/// \details By default BERDecodeAndCheckAlgorithmID() accepts an
- /// OID set by the user, ASN1::curve25519() and ASN1::Ed25519().
- /// ASN1::curve25519() is generic and says "this key is valid for
- /// curve25519 operations". ASN1::Ed25519() is specific and says
+ /// OID set by the user, <tt>ASN1::curve25519()</tt> and <tt>ASN1::Ed25519()</tt>.
+ /// <tt>ASN1::curve25519()</tt> is generic and says "this key is valid for
+ /// curve25519 operations". <tt>ASN1::Ed25519()</tt> is specific and says
/// "this key is valid for ed25519 signing."
void BERDecodeAndCheckAlgorithmID(BufferedTransformation& bt);
@@ -574,9 +574,9 @@ struct ed25519PublicKey : public X509PublicKey /// OID used by SSH, OIDs specified in draft-josefsson-pkix-newcurves,
/// and OIDs specified in draft-ietf-curdle-pkix.
/// \details By default BERDecodeAndCheckAlgorithmID() accepts an
- /// OID set by the user, ASN1::curve25519() and ASN1::Ed25519().
- /// ASN1::curve25519() is generic and says "this key is valid for
- /// curve25519 operations". ASN1::Ed25519() is specific and says
+ /// OID set by the user, <tt>ASN1::curve25519()</tt> and <tt>ASN1::Ed25519()</tt>.
+ /// <tt>ASN1::curve25519()</tt> is generic and says "this key is valid for
+ /// curve25519 operations". <tt>ASN1::Ed25519()</tt> is specific and says
/// "this key is valid for ed25519 signing."
void BERDecodeAndCheckAlgorithmID(BufferedTransformation& bt);
|