From: Gabor X Toth <*@tg-x.net>
Date: Fri, 23 Sep 2016 21:17:13 +0000 (+0000)
Subject: MQ doc
X-Git-Tag: initial-import-from-subversion-38251~225
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=f5e65b30356f20c7fd6f80fc1a9cb6de8e035505;p=oweals%2Fgnunet.git

MQ doc
---

diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h
index 567624985..08434698e 100644
--- a/src/include/gnunet_mq_lib.h
+++ b/src/include/gnunet_mq_lib.h
@@ -42,7 +42,8 @@
  * The allocated message will already have the type and size field set.
  *
  * @param mvar variable to store the allocated message in;
- *             must have a header field
+ *             must have a header field;
+ *             can be NULL
  * @param esize extra space to allocate after the message
  * @param type type of the message
  * @return the MQ message
@@ -54,7 +55,8 @@
  * The contained message will already have the type and size field set.
  *
  * @param mvar variable to store the allocated message in;
- *             must have a header field
+ *             must have a header field;
+ *             can be NULL
  * @param type type of the message
  * @return the allocated envelope
  */
@@ -111,6 +113,7 @@
  * @param mh message header to extract nested message header from
  * @param base_size size of the message before the nested message's header appears
  * @return pointer to the nested message, does not copy the message
+ *         OR NULL in case of a malformed message.
  */
 const struct GNUNET_MessageHeader *
 GNUNET_MQ_extract_nested_mh_ (const struct GNUNET_MessageHeader *mh,