aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/messenger_api_message.h
diff options
context:
space:
mode:
authorWillow Liquorice <willow@howhill.com>2022-09-07 20:44:52 +0100
committerWillow Liquorice <willow@howhill.com>2022-10-03 00:44:34 +0100
commitdd797c2c6c01520fa73b1fd335ccd42df86b1b4d (patch)
tree1f508fa523fa7c3400fbd4f95a344d7f44ce37c1 /src/messenger/messenger_api_message.h
parent1d0bbddfefaefb6e3f5cd240e56462a6bef2fa09 (diff)
downloadgnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.tar.gz
gnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.zip
-DOC: Documentation cleanup pass through MESSENGER subsystem
Diffstat (limited to 'src/messenger/messenger_api_message.h')
-rw-r--r--src/messenger/messenger_api_message.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/messenger/messenger_api_message.h b/src/messenger/messenger_api_message.h
index 46c5cb024..209d80a4e 100644
--- a/src/messenger/messenger_api_message.h
+++ b/src/messenger/messenger_api_message.h
@@ -64,7 +64,7 @@ copy_message (const struct GNUNET_MESSENGER_Message *message);
64/** 64/**
65 * Frees the messages body memory. 65 * Frees the messages body memory.
66 * 66 *
67 * @param[in/out] message Message 67 * @param[in,out] message Message
68 */ 68 */
69void 69void
70cleanup_message (struct GNUNET_MESSENGER_Message *message); 70cleanup_message (struct GNUNET_MESSENGER_Message *message);
@@ -72,7 +72,7 @@ cleanup_message (struct GNUNET_MESSENGER_Message *message);
72/** 72/**
73 * Destroys a message and frees its memory fully. 73 * Destroys a message and frees its memory fully.
74 * 74 *
75 * @param[in/out] message Message 75 * @param[in,out] message Message
76 */ 76 */
77void 77void
78destroy_message (struct GNUNET_MESSENGER_Message *message); 78destroy_message (struct GNUNET_MESSENGER_Message *message);
@@ -163,7 +163,7 @@ hash_message (const struct GNUNET_MESSENGER_Message *message,
163 * Signs the <i>hash</i> of a <i>message</i> with a given <i>ego</i> and writes the signature 163 * Signs the <i>hash</i> of a <i>message</i> with a given <i>ego</i> and writes the signature
164 * into the <i>buffer</i> as well. 164 * into the <i>buffer</i> as well.
165 * 165 *
166 * @param[in/out] message Message 166 * @param[in,out] message Message
167 * @param[in] length Length of buffer 167 * @param[in] length Length of buffer
168 * @param[out] buffer Buffer 168 * @param[out] buffer Buffer
169 * @param[in] hash Hash of message 169 * @param[in] hash Hash of message
@@ -196,7 +196,7 @@ verify_message (const struct GNUNET_MESSENGER_Message *message,
196 * and kind with the now private encrypted <i>message</i>. The function returns 196 * and kind with the now private encrypted <i>message</i>. The function returns
197 * #GNUNET_YES if the operation succeeded, otherwise #GNUNET_NO. 197 * #GNUNET_YES if the operation succeeded, otherwise #GNUNET_NO.
198 * 198 *
199 * @param[in/out] message Message 199 * @param[in,out] message Message
200 * @param[in] key Public key of EGO 200 * @param[in] key Public key of EGO
201 * @return #GNUNET_YES on success, otherwise #GNUNET_NO 201 * @return #GNUNET_YES on success, otherwise #GNUNET_NO
202 */ 202 */
@@ -209,7 +209,7 @@ encrypt_message (struct GNUNET_MESSENGER_Message *message,
209 * and kind with the inner encrypted message. The function returns #GNUNET_YES if the 209 * and kind with the inner encrypted message. The function returns #GNUNET_YES if the
210 * operation succeeded, otherwise #GNUNET_NO. 210 * operation succeeded, otherwise #GNUNET_NO.
211 * 211 *
212 * @param[in/out] message Message 212 * @param[in,out] message Message
213 * @param[in] key Private key of EGO 213 * @param[in] key Private key of EGO
214 * @return #GNUNET_YES on success, otherwise #GNUNET_NO 214 * @return #GNUNET_YES on success, otherwise #GNUNET_NO
215 */ 215 */