Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[uniffi] Make docstrings consistent #119

Merged
merged 1 commit into from
Mar 18, 2024
Merged

[uniffi] Make docstrings consistent #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions mls-rs-uniffi/src/lib.rs
View file
Open in desktop
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
Loading