message_correct: Document this module.

This commit is contained in:
Emmanuel Gil Peyrot 2018-08-01 00:27:48 +02:00
parent e757d8dde3
commit f0fab6b97e

View file

@ -4,10 +4,17 @@
// License, v. 2.0. If a copy of the MPL was not distributed with this // 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/. // file, You can obtain one at http://mozilla.org/MPL/2.0/.
generate_element!(Replace, "replace", MESSAGE_CORRECT, #![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: [ attributes: [
/// The 'id' attribute of the message getting corrected.
id: String = "id" => required, id: String = "id" => required,
]); ]
);
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {