[4/6] incubator-mynewt-core git commit: newtmgr - Add some comments.

[cc...@apache.org]

newtmgr - Add some comments.


Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/commit/9c977ef8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/tree/9c977ef8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/diff/9c977ef8

Branch: refs/heads/develop
Commit: 9c977ef871ae55e2ce45fd700fa270b5e914b2e3
Parents: a7d10ec
Author: Christopher Collins <cc...@apache.org>
Authored: Mon Dec 12 15:06:36 2016 -0800
Committer: Christopher Collins <cc...@apache.org>
Committed: Mon Dec 12 18:54:25 2016 -0800

----------------------------------------------------------------------
 mgmt/newtmgr/include/newtmgr/newtmgr.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/9c977ef8/mgmt/newtmgr/include/newtmgr/newtmgr.h
----------------------------------------------------------------------
diff --git a/mgmt/newtmgr/include/newtmgr/newtmgr.h b/mgmt/newtmgr/include/newtmgr/newtmgr.h
index 3c3081a..69a2d6b 100644
--- a/mgmt/newtmgr/include/newtmgr/newtmgr.h
+++ b/mgmt/newtmgr/include/newtmgr/newtmgr.h
@@ -43,8 +43,20 @@ struct nmgr_hdr {
 };
 
 struct nmgr_transport;
+
+/**
+ * Transmit function.  The supplied mbuf is always consumed, regardless of
+ * return code.
+ */
 typedef int (*nmgr_transport_out_func_t)(struct nmgr_transport *nt,
         struct os_mbuf *m);
+
+/**
+ * MTU query function.  The supplied mbuf should contain a request received
+ * from the peer whose MTU is being queried.  This function takes an mbuf
+ * parameter because some transports store connection-specific information in
+ * the mbuf user header (e.g., the BLE transport stores the connection handle).
+ */
 typedef uint16_t (*nmgr_transport_get_mtu_func_t)(struct os_mbuf *m);
 
 struct nmgr_transport {