[riot-notifications] [RIOT-OS/RIOT] gnrc_sixlowpan: document submodules according to #8511 (#10841)

Martine Lenders notifications at github.com
Tue Jan 22 12:18:10 CET 2019


miri64 commented on this pull request.



> + * - IPv6 datagram compression according to [RFC 6282](https://tools.ietf.org/html/rfc6282)
+ *   aka IPHC ([gnrc_sixlowpan_iphc](@ref net_gnrc_sixlowpan_iphc), IPv6
+ *   extension header NHC currently missing)
+ *
+ * Each sub-module has a `send` and `recv` function prefixed by their
+ * respective sub-module name with the following signatures
+ *
+ * ~~~~~~~~~~~~~~~~~~~~~ {.c}
+ * void send(gnrc_pktsnip_t *pkt, void *ctx, uint8_t page);
+ * void recv(gnrc_pktsnip_t *pkt, void *ctx, uint8_t page);
+ * ~~~~~~~~~~~~~~~~~~~~~
+ *
+ * A 6LoWPAN frame `pkt` is supposed to pass the sub-modules sequentially in
+ * the order of its dispatches on receive or the step that makes most sense next
+ * on send. After it was passed into another sub-module using the respective
+ * `send`/`recv` function a sub-module is not supposed to operate on `pkt`

Again, I don't know why you think `supposed` is vague... Should I use MUST?

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/10841#discussion_r249738232
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190122/eb1d503f/attachment.html>


More information about the notifications mailing list