diff options
author | TheJackiMonster <thejackimonster@gmail.com> | 2023-11-24 02:58:27 +0100 |
---|---|---|
committer | TheJackiMonster <thejackimonster@gmail.com> | 2023-11-24 02:58:27 +0100 |
commit | 007c80fa8c652a29f99f0fe2e6febca9c22faf69 (patch) | |
tree | 11694cb156bab6c063294850f362db5ef54cc324 | |
parent | 10374d3858aa089c5b70db77491856818ffb84b5 (diff) | |
download | gnunet-007c80fa8c652a29f99f0fe2e6febca9c22faf69.tar.gz gnunet-007c80fa8c652a29f99f0fe2e6febca9c22faf69.zip |
MESSENGER: Correct doxygen comments
Signed-off-by: TheJackiMonster <thejackimonster@gmail.com>
10 files changed, 26 insertions, 26 deletions
diff --git a/src/service/messenger/gnunet-service-messenger.h b/src/service/messenger/gnunet-service-messenger.h index 2c673d5f0..450f66bc7 100644 --- a/src/service/messenger/gnunet-service-messenger.h +++ b/src/service/messenger/gnunet-service-messenger.h | |||
@@ -41,7 +41,7 @@ struct GNUNET_MESSENGER_CreateMessage | |||
41 | }; | 41 | }; |
42 | 42 | ||
43 | /** | 43 | /** |
44 | * Message to update the handle (its EGO key) for a client | 44 | * Message to update the handle (its public key) for a client |
45 | */ | 45 | */ |
46 | struct GNUNET_MESSENGER_UpdateMessage | 46 | struct GNUNET_MESSENGER_UpdateMessage |
47 | { | 47 | { |
diff --git a/src/service/messenger/gnunet-service-messenger_handle.h b/src/service/messenger/gnunet-service-messenger_handle.h index 77539a32e..feb121284 100644 --- a/src/service/messenger/gnunet-service-messenger_handle.h +++ b/src/service/messenger/gnunet-service-messenger_handle.h | |||
@@ -69,20 +69,20 @@ void | |||
69 | destroy_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle); | 69 | destroy_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle); |
70 | 70 | ||
71 | /** | 71 | /** |
72 | * Sets the public key from the EGO of a given <i>handle</i>. | 72 | * Sets the public key of a given <i>handle</i>. |
73 | * | 73 | * |
74 | * @param[out] handle Handle | 74 | * @param[out] handle Handle |
75 | * @param[in] key Public key of EGO | 75 | * @param[in] key Public key |
76 | */ | 76 | */ |
77 | void | 77 | void |
78 | set_srv_handle_key (struct GNUNET_MESSENGER_SrvHandle *handle, | 78 | set_srv_handle_key (struct GNUNET_MESSENGER_SrvHandle *handle, |
79 | const struct GNUNET_CRYPTO_PublicKey *key); | 79 | const struct GNUNET_CRYPTO_PublicKey *key); |
80 | 80 | ||
81 | /** | 81 | /** |
82 | * Returns the public key from the EGO of a given <i>handle</i>. | 82 | * Returns the public key of a given <i>handle</i>. |
83 | * | 83 | * |
84 | * @param[in] handle Handle | 84 | * @param[in] handle Handle |
85 | * @return Public key of handles EGO | 85 | * @return Public key of handle |
86 | */ | 86 | */ |
87 | const struct GNUNET_CRYPTO_PublicKey* | 87 | const struct GNUNET_CRYPTO_PublicKey* |
88 | get_srv_handle_key (const struct GNUNET_MESSENGER_SrvHandle *handle); | 88 | get_srv_handle_key (const struct GNUNET_MESSENGER_SrvHandle *handle); |
diff --git a/src/service/messenger/gnunet-service-messenger_member.h b/src/service/messenger/gnunet-service-messenger_member.h index e456554a6..1f239aa21 100644 --- a/src/service/messenger/gnunet-service-messenger_member.h +++ b/src/service/messenger/gnunet-service-messenger_member.h | |||
@@ -120,7 +120,7 @@ sync_member_contacts (struct GNUNET_MESSENGER_Member *member); | |||
120 | * If the member does not provide a session with the given key, NULL gets returned. | 120 | * If the member does not provide a session with the given key, NULL gets returned. |
121 | * | 121 | * |
122 | * @param[in] member Member | 122 | * @param[in] member Member |
123 | * @param[in] public_key Public key of EGO | 123 | * @param[in] public_key Public key |
124 | * @return Member session | 124 | * @return Member session |
125 | */ | 125 | */ |
126 | struct GNUNET_MESSENGER_MemberSession* | 126 | struct GNUNET_MESSENGER_MemberSession* |
diff --git a/src/service/messenger/gnunet-service-messenger_member_session.h b/src/service/messenger/gnunet-service-messenger_member_session.h index a039cc781..a702e52f6 100644 --- a/src/service/messenger/gnunet-service-messenger_member_session.h +++ b/src/service/messenger/gnunet-service-messenger_member_session.h | |||
@@ -63,7 +63,7 @@ struct GNUNET_MESSENGER_MemberSession | |||
63 | * If the creation fails, NULL gets returned. | 63 | * If the creation fails, NULL gets returned. |
64 | * | 64 | * |
65 | * @param[in,out] member Member | 65 | * @param[in,out] member Member |
66 | * @param[in] pubkey Public key of EGO | 66 | * @param[in] pubkey Public key |
67 | * @return New member session | 67 | * @return New member session |
68 | */ | 68 | */ |
69 | struct GNUNET_MESSENGER_MemberSession* | 69 | struct GNUNET_MESSENGER_MemberSession* |
@@ -171,10 +171,10 @@ const struct GNUNET_ShortHashCode* | |||
171 | get_member_session_id (const struct GNUNET_MESSENGER_MemberSession *session); | 171 | get_member_session_id (const struct GNUNET_MESSENGER_MemberSession *session); |
172 | 172 | ||
173 | /** | 173 | /** |
174 | * Returns the public key from an EGO of a given member <i>session</i>. | 174 | * Returns the public key of a given member <i>session</i>. |
175 | * | 175 | * |
176 | * @param[in] session Member session | 176 | * @param[in] session Member session |
177 | * @return Public key of EGO | 177 | * @return Public key |
178 | */ | 178 | */ |
179 | const struct GNUNET_CRYPTO_PublicKey* | 179 | const struct GNUNET_CRYPTO_PublicKey* |
180 | get_member_session_public_key (const struct | 180 | get_member_session_public_key (const struct |
diff --git a/src/service/messenger/gnunet-service-messenger_room.h b/src/service/messenger/gnunet-service-messenger_room.h index e3e561d8b..c5381850d 100644 --- a/src/service/messenger/gnunet-service-messenger_room.h +++ b/src/service/messenger/gnunet-service-messenger_room.h | |||
@@ -174,7 +174,7 @@ enter_srv_room_at (struct GNUNET_MESSENGER_SrvRoom *room, | |||
174 | /** | 174 | /** |
175 | * Packs a <i>message</i> depending on the selected <i>mode</i> into a newly allocated envelope. It will set the | 175 | * Packs a <i>message</i> depending on the selected <i>mode</i> into a newly allocated envelope. It will set the |
176 | * timestamp of the message, the sender id and the previous messages hash automatically before packing. The message | 176 | * timestamp of the message, the sender id and the previous messages hash automatically before packing. The message |
177 | * will be signed by the handles EGO. | 177 | * will be signed by the handles private key. |
178 | * | 178 | * |
179 | * If the optional <i>hash</i> parameter is a valid pointer, its value will be overridden by the signed messages hash. | 179 | * If the optional <i>hash</i> parameter is a valid pointer, its value will be overridden by the signed messages hash. |
180 | * | 180 | * |
@@ -340,7 +340,7 @@ request_srv_room_message (struct GNUNET_MESSENGER_SrvRoom *room, | |||
340 | * use an already used member id (comparing public key and timestamp). | 340 | * use an already used member id (comparing public key and timestamp). |
341 | * | 341 | * |
342 | * @param[in,out] room Room | 342 | * @param[in,out] room Room |
343 | * @param[in] public_key Public key of EGO | 343 | * @param[in] public_key Public key |
344 | * @param[in] member_id Member ID | 344 | * @param[in] member_id Member ID |
345 | * @param[in] timestamp Timestamp | 345 | * @param[in] timestamp Timestamp |
346 | */ | 346 | */ |
diff --git a/src/service/messenger/messenger_api_contact.h b/src/service/messenger/messenger_api_contact.h index b2e3fc364..cbb079d4c 100644 --- a/src/service/messenger/messenger_api_contact.h +++ b/src/service/messenger/messenger_api_contact.h | |||
@@ -1,6 +1,6 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of GNUnet. | 2 | This file is part of GNUnet. |
3 | Copyright (C) 2020--2021 GNUnet e.V. | 3 | Copyright (C) 2020--2023 GNUnet e.V. |
4 | 4 | ||
5 | GNUnet is free software: you can redistribute it and/or modify it | 5 | GNUnet is free software: you can redistribute it and/or modify it |
6 | under the terms of the GNU Affero General Public License as published | 6 | under the terms of the GNU Affero General Public License as published |
@@ -40,7 +40,7 @@ struct GNUNET_MESSENGER_Contact | |||
40 | }; | 40 | }; |
41 | 41 | ||
42 | /** | 42 | /** |
43 | * Creates and allocates a new contact with a given public <i>key</i> from an EGO. | 43 | * Creates and allocates a new contact with a given public <i>key</i>. |
44 | * | 44 | * |
45 | * @param[in] key Public key | 45 | * @param[in] key Public key |
46 | * @param[in] unique_id Locally unique identifier | 46 | * @param[in] unique_id Locally unique identifier |
diff --git a/src/service/messenger/messenger_api_contact_store.h b/src/service/messenger/messenger_api_contact_store.h index 4520e0a47..8654273ea 100644 --- a/src/service/messenger/messenger_api_contact_store.h +++ b/src/service/messenger/messenger_api_contact_store.h | |||
@@ -86,7 +86,7 @@ get_store_contact_raw (struct GNUNET_MESSENGER_ContactStore *store, | |||
86 | * | 86 | * |
87 | * @param[in,out] store Contact store | 87 | * @param[in,out] store Contact store |
88 | * @param[in] context Member context | 88 | * @param[in] context Member context |
89 | * @param[in] pubkey Public key of EGO | 89 | * @param[in] pubkey Public key |
90 | */ | 90 | */ |
91 | struct GNUNET_MESSENGER_Contact* | 91 | struct GNUNET_MESSENGER_Contact* |
92 | get_store_contact (struct GNUNET_MESSENGER_ContactStore *store, | 92 | get_store_contact (struct GNUNET_MESSENGER_ContactStore *store, |
@@ -103,7 +103,7 @@ get_store_contact (struct GNUNET_MESSENGER_ContactStore *store, | |||
103 | * @param[in,out] contact Contact | 103 | * @param[in,out] contact Contact |
104 | * @param[in] context Member context | 104 | * @param[in] context Member context |
105 | * @param[in] next_context Member context | 105 | * @param[in] next_context Member context |
106 | * @param[in] pubkey Public key of EGO | 106 | * @param[in] pubkey Public key |
107 | */ | 107 | */ |
108 | void | 108 | void |
109 | update_store_contact (struct GNUNET_MESSENGER_ContactStore *store, | 109 | update_store_contact (struct GNUNET_MESSENGER_ContactStore *store, |
diff --git a/src/service/messenger/messenger_api_message.c b/src/service/messenger/messenger_api_message.c index c1bc0f5c0..8bd34f8f7 100644 --- a/src/service/messenger/messenger_api_message.c +++ b/src/service/messenger/messenger_api_message.c | |||
@@ -1109,7 +1109,7 @@ int | |||
1109 | filter_message_sending (const struct GNUNET_MESSENGER_Message *message) | 1109 | filter_message_sending (const struct GNUNET_MESSENGER_Message *message) |
1110 | { | 1110 | { |
1111 | if (GNUNET_YES == is_peer_message (message)) | 1111 | if (GNUNET_YES == is_peer_message (message)) |
1112 | return GNUNET_SYSERR; // Requires signature of peer rather than ego! | 1112 | return GNUNET_SYSERR; // Requires signature of peer rather than member! |
1113 | 1113 | ||
1114 | switch (message->header.kind) | 1114 | switch (message->header.kind) |
1115 | { | 1115 | { |
diff --git a/src/service/messenger/messenger_api_message.h b/src/service/messenger/messenger_api_message.h index ca507f8c9..1874a4fe4 100644 --- a/src/service/messenger/messenger_api_message.h +++ b/src/service/messenger/messenger_api_message.h | |||
@@ -158,14 +158,14 @@ hash_message (const struct GNUNET_MESSENGER_Message *message, | |||
158 | struct GNUNET_HashCode *hash); | 158 | struct GNUNET_HashCode *hash); |
159 | 159 | ||
160 | /** | 160 | /** |
161 | * Signs the <i>hash</i> of a <i>message</i> with a given <i>ego</i> and writes the signature | 161 | * Signs the <i>hash</i> of a <i>message</i> with a given private <i>key</i> and writes |
162 | * into the <i>buffer</i> as well. | 162 | * the signature into the <i>buffer</i> as well. |
163 | * | 163 | * |
164 | * @param[in,out] message Message | 164 | * @param[in,out] message Message |
165 | * @param[in] length Length of buffer | 165 | * @param[in] length Length of buffer |
166 | * @param[out] buffer Buffer | 166 | * @param[out] buffer Buffer |
167 | * @param[in] hash Hash of message | 167 | * @param[in] hash Hash of message |
168 | * @param[in] key Private key of EGO | 168 | * @param[in] key Private key |
169 | */ | 169 | */ |
170 | void | 170 | void |
171 | sign_message (struct GNUNET_MESSENGER_Message *message, | 171 | sign_message (struct GNUNET_MESSENGER_Message *message, |
@@ -198,7 +198,7 @@ sign_message_by_peer (struct GNUNET_MESSENGER_Message *message, | |||
198 | * | 198 | * |
199 | * @param[in] message Message | 199 | * @param[in] message Message |
200 | * @param[in] hash Hash of message | 200 | * @param[in] hash Hash of message |
201 | * @param[in] key Public key of EGO | 201 | * @param[in] key Public key |
202 | * @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR | 202 | * @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR |
203 | */ | 203 | */ |
204 | int | 204 | int |
@@ -227,7 +227,7 @@ verify_message_by_peer (const struct GNUNET_MESSENGER_Message *message, | |||
227 | * #GNUNET_YES if the operation succeeded, otherwise #GNUNET_NO. | 227 | * #GNUNET_YES if the operation succeeded, otherwise #GNUNET_NO. |
228 | * | 228 | * |
229 | * @param[in,out] message Message | 229 | * @param[in,out] message Message |
230 | * @param[in] key Public key of EGO | 230 | * @param[in] key Public key |
231 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO | 231 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO |
232 | */ | 232 | */ |
233 | int | 233 | int |
@@ -240,7 +240,7 @@ encrypt_message (struct GNUNET_MESSENGER_Message *message, | |||
240 | * operation succeeded, otherwise #GNUNET_NO. | 240 | * operation succeeded, otherwise #GNUNET_NO. |
241 | * | 241 | * |
242 | * @param[in,out] message Message | 242 | * @param[in,out] message Message |
243 | * @param[in] key Private key of EGO | 243 | * @param[in] key Private key |
244 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO | 244 | * @return #GNUNET_YES on success, otherwise #GNUNET_NO |
245 | */ | 245 | */ |
246 | int | 246 | int |
@@ -280,7 +280,7 @@ pack_message (struct GNUNET_MESSENGER_Message *message, | |||
280 | 280 | ||
281 | /** | 281 | /** |
282 | * Returns whether a specific kind of message can be sent by the service without usage of a | 282 | * Returns whether a specific kind of message can be sent by the service without usage of a |
283 | * clients EGO. The function returns #GNUNET_YES if the kind of message can be signed | 283 | * clients private key. The function returns #GNUNET_YES if the kind of message can be signed |
284 | * via a peer's identity, otherwise #GNUNET_NO. | 284 | * via a peer's identity, otherwise #GNUNET_NO. |
285 | * | 285 | * |
286 | * @param[in] message Message | 286 | * @param[in] message Message |
diff --git a/src/service/messenger/messenger_api_message_kind.h b/src/service/messenger/messenger_api_message_kind.h index 5a544a41b..5f7421c07 100644 --- a/src/service/messenger/messenger_api_message_kind.h +++ b/src/service/messenger/messenger_api_message_kind.h | |||
@@ -35,10 +35,10 @@ | |||
35 | #include "gnunet-service-messenger_service.h" | 35 | #include "gnunet-service-messenger_service.h" |
36 | 36 | ||
37 | /** | 37 | /** |
38 | * Creates and allocates a new join message containing the clients EGO public <i>key</i>. | 38 | * Creates and allocates a new join message containing the clients public <i>key</i>. |
39 | * (all values are stored as copy) | 39 | * (all values are stored as copy) |
40 | * | 40 | * |
41 | * @param[in] key Private key of EGO | 41 | * @param[in] key Private key |
42 | * @return New message | 42 | * @return New message |
43 | */ | 43 | */ |
44 | struct GNUNET_MESSENGER_Message* | 44 | struct GNUNET_MESSENGER_Message* |
@@ -66,7 +66,7 @@ create_message_name (const char *name); | |||
66 | * Creates and allocates a new key message containing the public <i>key</i> to change to derived | 66 | * Creates and allocates a new key message containing the public <i>key</i> to change to derived |
67 | * from its private counterpart. (all values are stored as copy) | 67 | * from its private counterpart. (all values are stored as copy) |
68 | * | 68 | * |
69 | * @param[in] key Private key of EGO | 69 | * @param[in] key Private key |
70 | * @return New message | 70 | * @return New message |
71 | */ | 71 | */ |
72 | struct GNUNET_MESSENGER_Message* | 72 | struct GNUNET_MESSENGER_Message* |