receipts: Document this module.

This commit is contained in:
Emmanuel Gil Peyrot 2018-08-02 19:24:09 +02:00
parent 36cfe76e4d
commit a70ce99d91

View file

@ -4,12 +4,23 @@
// 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_empty_element!(Request, "request", RECEIPTS); #![deny(missing_docs)]
generate_element!(Received, "received", RECEIPTS, generate_empty_element!(
attributes: [ /// Requests that this message is acked by the final recipient once
id: Option<String> = "id" => optional, /// received.
]); Request, "request", RECEIPTS
);
generate_element!(
/// Notes that a previous message has correctly been received, it is
/// referenced by its 'id' attribute.
Received, "received", RECEIPTS,
attributes: [
/// The 'id' attribute of the received message.
id: Option<String> = "id" => optional,
]
);
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {