Correct doc comments re: HTML tags

This commit is contained in:
Luke Parker 2023-03-07 05:34:29 -05:00
parent 11114dcb74
commit 1e201562df
No known key found for this signature in database
4 changed files with 5 additions and 5 deletions
crypto
dleq/src
frost/src
schnorr/src

View file

@ -191,7 +191,7 @@ impl<G: PrimeGroup> DLEqProof<G> {
Ok(DLEqProof { c: read_scalar(r)?, s: read_scalar(r)? })
}
/// Serialize a DLEq proof to a Vec<u8>.
/// Serialize a DLEq proof to a `Vec<u8>`.
#[cfg(feature = "serialize")]
pub fn serialize(&self) -> Vec<u8> {
let mut res = vec![];
@ -315,7 +315,7 @@ impl<G: PrimeGroup> MultiDLEqProof<G> {
Ok(MultiDLEqProof { c, s })
}
/// Serialize a multi-DLEq proof to a Vec<u8>.
/// Serialize a multi-DLEq proof to a `Vec<u8>`.
#[cfg(feature = "serialize")]
pub fn serialize(&self) -> Vec<u8> {
let mut res = vec![];

View file

@ -155,7 +155,7 @@ impl<C: Curve, T: Clone + Debug + Transcript, H: Hram<C>> Schnorr<C, T, H> {
impl<C: Curve, H: Hram<C>> IetfSchnorr<C, H> {
/// Construct a IETF-compatible Schnorr algorithm.
///
/// Please see the IetfSchnorr documentation for the full details of this.
/// Please see the `IetfSchnorr` documentation for the full details of this.
pub fn ietf() -> IetfSchnorr<C, H> {
Schnorr::new(IetfTranscript(vec![]))
}

View file

@ -99,7 +99,7 @@ impl<C: Ciphersuite> SchnorrAggregate<C> {
writer.write_all(self.s.to_repr().as_ref())
}
/// Serialize a SchnorrAggregate, returning a Vec<u8>.
/// Serialize a SchnorrAggregate, returning a `Vec<u8>`.
pub fn serialize(&self) -> Vec<u8> {
let mut buf = vec![];
self.write(&mut buf).unwrap();

View file

@ -46,7 +46,7 @@ impl<C: Ciphersuite> SchnorrSignature<C> {
writer.write_all(self.s.to_repr().as_ref())
}
/// Serialize a SchnorrSignature, returning a Vec<u8>.
/// Serialize a SchnorrSignature, returning a `Vec<u8>`.
pub fn serialize(&self) -> Vec<u8> {
let mut buf = vec![];
self.write(&mut buf).unwrap();