From 02db34d94d7eb6d14a325d4a47ae12bc7f777b48 Mon Sep 17 00:00:00 2001
From: Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
Date: Wed, 8 Aug 2018 19:15:25 +0200
Subject: [PATCH] ibr: Document this module.

---
 src/ibr.rs | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/ibr.rs b/src/ibr.rs
index 750b3e2869f251d6e60ae54e22d13cddcac858a6..72324deeec3d7dbe86d7cdce05595a6a3ba29325 100644
--- a/src/ibr.rs
+++ b/src/ibr.rs
@@ -4,8 +4,6 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-#![allow(missing_docs)]
-
 use std::collections::HashMap;
 use try_from::TryFrom;
 
@@ -18,12 +16,22 @@ use data_forms::DataForm;
 
 use ns;
 
+/// Query for registering against a service.
 #[derive(Debug, Clone)]
 pub struct Query {
+    /// Deprecated fixed list of possible fields to fill before the user can
+    /// register.
     pub fields: HashMap<String, String>,
+
+    /// Whether this account is already registered.
     pub registered: bool,
+
+    /// Whether to remove this account.
     pub remove: bool,
+
+    /// A data form the user must fill before being allowed to register.
     pub form: Option<DataForm>,
+
     // Not yet implemented.
     //pub oob: Option<Oob>,
 }