[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet] 02/03: MESSENGER: Correct doxygen comments
|
From: |
gnunet |
|
Subject: |
[gnunet] 02/03: MESSENGER: Correct doxygen comments |
|
Date: |
Fri, 24 Nov 2023 03:03:45 +0100 |
This is an automated email from the git hooks/post-receive script.
thejackimonster pushed a commit to branch master
in repository gnunet.
commit 007c80fa8c652a29f99f0fe2e6febca9c22faf69
Author: TheJackiMonster <thejackimonster@gmail.com>
AuthorDate: Fri Nov 24 02:58:27 2023 +0100
MESSENGER: Correct doxygen comments
Signed-off-by: TheJackiMonster <thejackimonster@gmail.com>
---
src/service/messenger/gnunet-service-messenger.h | 2 +-
src/service/messenger/gnunet-service-messenger_handle.h | 8 ++++----
src/service/messenger/gnunet-service-messenger_member.h | 2 +-
.../messenger/gnunet-service-messenger_member_session.h | 6 +++---
src/service/messenger/gnunet-service-messenger_room.h | 4 ++--
src/service/messenger/messenger_api_contact.h | 4 ++--
src/service/messenger/messenger_api_contact_store.h | 4 ++--
src/service/messenger/messenger_api_message.c | 2 +-
src/service/messenger/messenger_api_message.h | 14 +++++++-------
src/service/messenger/messenger_api_message_kind.h | 6 +++---
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
};
/**
- * Message to update the handle (its EGO key) for a client
+ * Message to update the handle (its public key) for a client
*/
struct GNUNET_MESSENGER_UpdateMessage
{
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
destroy_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle);
/**
- * Sets the public key from the EGO of a given <i>handle</i>.
+ * Sets the public key of a given <i>handle</i>.
*
* @param[out] handle Handle
- * @param[in] key Public key of EGO
+ * @param[in] key Public key
*/
void
set_srv_handle_key (struct GNUNET_MESSENGER_SrvHandle *handle,
const struct GNUNET_CRYPTO_PublicKey *key);
/**
- * Returns the public key from the EGO of a given <i>handle</i>.
+ * Returns the public key of a given <i>handle</i>.
*
* @param[in] handle Handle
- * @return Public key of handles EGO
+ * @return Public key of handle
*/
const struct GNUNET_CRYPTO_PublicKey*
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);
* If the member does not provide a session with the given key, NULL gets
returned.
*
* @param[in] member Member
- * @param[in] public_key Public key of EGO
+ * @param[in] public_key Public key
* @return Member session
*/
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
* If the creation fails, NULL gets returned.
*
* @param[in,out] member Member
- * @param[in] pubkey Public key of EGO
+ * @param[in] pubkey Public key
* @return New member session
*/
struct GNUNET_MESSENGER_MemberSession*
@@ -171,10 +171,10 @@ const struct GNUNET_ShortHashCode*
get_member_session_id (const struct GNUNET_MESSENGER_MemberSession *session);
/**
- * Returns the public key from an EGO of a given member <i>session</i>.
+ * Returns the public key of a given member <i>session</i>.
*
* @param[in] session Member session
- * @return Public key of EGO
+ * @return Public key
*/
const struct GNUNET_CRYPTO_PublicKey*
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,
/**
* Packs a <i>message</i> depending on the selected <i>mode</i> into a newly
allocated envelope. It will set the
* timestamp of the message, the sender id and the previous messages hash
automatically before packing. The message
- * will be signed by the handles EGO.
+ * will be signed by the handles private key.
*
* If the optional <i>hash</i> parameter is a valid pointer, its value will be
overridden by the signed messages hash.
*
@@ -340,7 +340,7 @@ request_srv_room_message (struct GNUNET_MESSENGER_SrvRoom
*room,
* use an already used member id (comparing public key and timestamp).
*
* @param[in,out] room Room
- * @param[in] public_key Public key of EGO
+ * @param[in] public_key Public key
* @param[in] member_id Member ID
* @param[in] timestamp Timestamp
*/
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 @@
/*
This file is part of GNUnet.
- Copyright (C) 2020--2021 GNUnet e.V.
+ Copyright (C) 2020--2023 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
@@ -40,7 +40,7 @@ struct GNUNET_MESSENGER_Contact
};
/**
- * Creates and allocates a new contact with a given public <i>key</i> from an
EGO.
+ * Creates and allocates a new contact with a given public <i>key</i>.
*
* @param[in] key Public key
* @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,
*
* @param[in,out] store Contact store
* @param[in] context Member context
- * @param[in] pubkey Public key of EGO
+ * @param[in] pubkey Public key
*/
struct GNUNET_MESSENGER_Contact*
get_store_contact (struct GNUNET_MESSENGER_ContactStore *store,
@@ -103,7 +103,7 @@ get_store_contact (struct GNUNET_MESSENGER_ContactStore
*store,
* @param[in,out] contact Contact
* @param[in] context Member context
* @param[in] next_context Member context
- * @param[in] pubkey Public key of EGO
+ * @param[in] pubkey Public key
*/
void
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
filter_message_sending (const struct GNUNET_MESSENGER_Message *message)
{
if (GNUNET_YES == is_peer_message (message))
- return GNUNET_SYSERR; // Requires signature of peer rather than ego!
+ return GNUNET_SYSERR; // Requires signature of peer rather than member!
switch (message->header.kind)
{
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,
struct GNUNET_HashCode *hash);
/**
- * Signs the <i>hash</i> of a <i>message</i> with a given <i>ego</i> and
writes the signature
- * into the <i>buffer</i> as well.
+ * Signs the <i>hash</i> of a <i>message</i> with a given private <i>key</i>
and writes
+ * the signature into the <i>buffer</i> as well.
*
* @param[in,out] message Message
* @param[in] length Length of buffer
* @param[out] buffer Buffer
* @param[in] hash Hash of message
- * @param[in] key Private key of EGO
+ * @param[in] key Private key
*/
void
sign_message (struct GNUNET_MESSENGER_Message *message,
@@ -198,7 +198,7 @@ sign_message_by_peer (struct GNUNET_MESSENGER_Message
*message,
*
* @param[in] message Message
* @param[in] hash Hash of message
- * @param[in] key Public key of EGO
+ * @param[in] key Public key
* @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR
*/
int
@@ -227,7 +227,7 @@ verify_message_by_peer (const struct
GNUNET_MESSENGER_Message *message,
* #GNUNET_YES if the operation succeeded, otherwise #GNUNET_NO.
*
* @param[in,out] message Message
- * @param[in] key Public key of EGO
+ * @param[in] key Public key
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
int
@@ -240,7 +240,7 @@ encrypt_message (struct GNUNET_MESSENGER_Message *message,
* operation succeeded, otherwise #GNUNET_NO.
*
* @param[in,out] message Message
- * @param[in] key Private key of EGO
+ * @param[in] key Private key
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
int
@@ -280,7 +280,7 @@ pack_message (struct GNUNET_MESSENGER_Message *message,
/**
* Returns whether a specific kind of message can be sent by the service
without usage of a
- * clients EGO. The function returns #GNUNET_YES if the kind of message can be
signed
+ * clients private key. The function returns #GNUNET_YES if the kind of
message can be signed
* via a peer's identity, otherwise #GNUNET_NO.
*
* @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 @@
#include "gnunet-service-messenger_service.h"
/**
- * Creates and allocates a new join message containing the clients EGO public
<i>key</i>.
+ * Creates and allocates a new join message containing the clients public
<i>key</i>.
* (all values are stored as copy)
*
- * @param[in] key Private key of EGO
+ * @param[in] key Private key
* @return New message
*/
struct GNUNET_MESSENGER_Message*
@@ -66,7 +66,7 @@ create_message_name (const char *name);
* Creates and allocates a new key message containing the public <i>key</i> to
change to derived
* from its private counterpart. (all values are stored as copy)
*
- * @param[in] key Private key of EGO
+ * @param[in] key Private key
* @return New message
*/
struct GNUNET_MESSENGER_Message*
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.