Skip to content

Commit

Permalink
[uniffi] Make docstrings consistent
Browse files Browse the repository at this point in the history
The “light-weight” descriptions are a left-over from when the library
was called mls-lite and seen as a light-weight wrapper around mls-rs.
The mls-rs-uniffi library is now more focused on being a FFI layer.
  • Loading branch information
mgeisler committed Mar 18, 2024
1 parent 650ed8d commit 852cb5d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions mls-rs-uniffi/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ pub struct SignatureKeypair {
secret_key: Arc<SignatureSecretKey>,
}

/// Light-weight wrapper around a [`mls_rs::ExtensionList`].
/// A [`mls_rs::ExtensionList`] wrapper.
#[derive(uniffi::Object, Debug, Clone)]
pub struct ExtensionList {
_inner: mls_rs::ExtensionList,
Expand All @@ -119,7 +119,7 @@ impl From<mls_rs::ExtensionList> for ExtensionList {
}
}

/// Light-weight wrapper around a [`mls_rs::Extension`].
/// A [`mls_rs::Extension`] wrapper.
#[derive(uniffi::Object, Debug, Clone)]
pub struct Extension {
_inner: mls_rs::Extension,
Expand All @@ -131,7 +131,7 @@ impl From<mls_rs::Extension> for Extension {
}
}

/// Light-weight wrapper around a [`mls_rs::Group`] and a [`mls_rs::group::NewMemberInfo`].
/// A [`mls_rs::Group`] and [`mls_rs::group::NewMemberInfo`] wrapper.
#[derive(uniffi::Record, Clone)]
pub struct JoinInfo {
/// The group that was joined.
Expand All @@ -158,7 +158,7 @@ impl TryFrom<mls_rs::ProtocolVersion> for ProtocolVersion {
}
}

/// Light-weight wrapper around a [`mls_rs::MlsMessage`].
/// A [`mls_rs::MlsMessage`] wrapper.
#[derive(Clone, Debug, uniffi::Object)]
pub struct Message {
inner: mls_rs::MlsMessage,
Expand All @@ -181,7 +181,7 @@ impl From<mls_rs::group::proposal::Proposal> for Proposal {
}
}

/// Light-weight wrapper around a [`mls_rs::group::ReceivedMessage`].
/// A [`mls_rs::group::ReceivedMessage`] wrapper.
#[derive(Clone, Debug, uniffi::Enum)]
pub enum ReceivedMessage {
/// A decrypted application message.
Expand Down

0 comments on commit 852cb5d

Please sign in to comment.