From 9d3028ad715657aa6a7dcea5797d1cb6fd2ddf8a Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Mon, 2 Jul 2018 13:51:36 +0200 Subject: [PATCH] jingle_ibb: Add documentation. --- src/jingle_ibb.rs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/jingle_ibb.rs b/src/jingle_ibb.rs index dc4702f6..a36f0618 100644 --- a/src/jingle_ibb.rs +++ b/src/jingle_ibb.rs @@ -4,12 +4,22 @@ // 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/. +#![deny(missing_docs)] + use ibb::{Stanza, StreamId}; -generate_element!(Transport, "transport", JINGLE_IBB, +generate_element!( +/// Describes an [In-Band Bytestream](https://xmpp.org/extensions/xep-0047.html) +/// Jingle transport, see also the [IBB module](../ibb.rs). +Transport, "transport", JINGLE_IBB, attributes: [ + /// Maximum size in bytes for each chunk. block_size: u16 = "block-size" => required, + + /// The identifier to be used to create a stream. sid: StreamId = "sid" => required, + + /// Which stanza type to use to exchange data. stanza: Stanza = "stanza" => default, ]);