From 08babb6d6cb988236b181c26ee0f57be09913860 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damir=20Jeli=C4=87?= <poljar@termina.org.uk>
Date: Tue, 1 Dec 2020 10:54:41 +0100
Subject: [PATCH] crypto: Document the new cross signing methods in the store.

---
 matrix_sdk_crypto/src/store/mod.rs | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/matrix_sdk_crypto/src/store/mod.rs b/matrix_sdk_crypto/src/store/mod.rs
index 3fda11ba..1a64d944 100644
--- a/matrix_sdk_crypto/src/store/mod.rs
+++ b/matrix_sdk_crypto/src/store/mod.rs
@@ -342,13 +342,22 @@ pub trait CryptoStore: Debug {
     /// * `account` - The account that should be stored.
     async fn save_account(&self, account: ReadOnlyAccount) -> Result<()>;
 
-    /// TODO
+    /// Save the given privat identity in the store.
+    ///
+    /// # Arguments
+    ///
+    /// * `identity` - The private cross signing identity that should be saved
+    /// in the store.
     async fn save_identity(&self, identity: PrivateCrossSigningIdentity) -> Result<()>;
 
-    /// TODO
+    /// Try to load a private cross signing identity, if one is stored.
     async fn load_identity(&self) -> Result<Option<PrivateCrossSigningIdentity>>;
 
-    /// TODO
+    /// Save the set of changes to the store.
+    ///
+    /// # Arguments
+    ///
+    /// * `changes` - The set of changes that should be stored.
     async fn save_changes(&self, changes: Changes) -> Result<()>;
 
     /// Get all the sessions that belong to the given sender key.