From ccda5c7260447d046a13db68d42a2f439cabbbec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Wed, 12 Aug 2020 13:11:51 +0200 Subject: [PATCH] crypto: Small doc improvements to the OlmMachine. --- matrix_sdk_crypto/src/machine.rs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/matrix_sdk_crypto/src/machine.rs b/matrix_sdk_crypto/src/machine.rs index 7a5486bfc..9828467b0 100644 --- a/matrix_sdk_crypto/src/machine.rs +++ b/matrix_sdk_crypto/src/machine.rs @@ -272,12 +272,14 @@ impl OlmMachine { /// This should be called every time a group session needs to be shared. /// /// The response of a successful key claiming requests needs to be passed to - /// the `OlmMachine` with the `receive_keys_claim_response()`. + /// the `OlmMachine` with the [`receive_keys_claim_response`]. /// /// # Arguments /// /// `users` - The list of users that we should check if we lack a session /// with one of their devices. + /// + /// [`receive_keys_claim_response`]: #method.receive_keys_claim_response pub async fn get_missing_sessions( &self, users: impl Iterator, @@ -470,6 +472,12 @@ impl OlmMachine { /// Get a tuple of device and one-time keys that need to be uploaded. /// /// Returns an empty error if no keys need to be uploaded. + /// + /// The response of a successful key upload requests needs to be passed to + /// the [`OlmMachine`] with the [`receive_keys_upload_response`]. + /// + /// [`receive_keys_upload_response`]: #method.receive_keys_upload_response + /// [`OlmMachine`]: struct.OlmMachine.html pub async fn keys_for_upload( &self, ) -> StdResult<(Option, Option), ()> {