From f0fab6b97e08fd48f82ec96a6bd03e076bec5f0b Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Wed, 1 Aug 2018 00:27:48 +0200 Subject: [PATCH] message_correct: Document this module. --- src/message_correct.rs | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/src/message_correct.rs b/src/message_correct.rs index f3019797..3dbd5120 100644 --- a/src/message_correct.rs +++ b/src/message_correct.rs @@ -4,10 +4,17 @@ // 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/. -generate_element!(Replace, "replace", MESSAGE_CORRECT, -attributes: [ - id: String = "id" => required, -]); +#![deny(missing_docs)] + +generate_element!( + /// Defines that the message containing this payload should replace a + /// previous message, identified by the id. + Replace, "replace", MESSAGE_CORRECT, + attributes: [ + /// The 'id' attribute of the message getting corrected. + id: String = "id" => required, + ] +); #[cfg(test)] mod tests {