Skip to content

Commit c310e57

Browse files
committed
Address some outdated doc comments
1 parent 4f132e8 commit c310e57

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed

include/session/session_protocol.h

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ typedef struct session_protocol_encrypted_for_destination {
128128
/// Determine the Pro features that are used in a given conversation message.
129129
///
130130
/// Inputs:
131-
/// - `msg_size` -- the size of the message in bytes to determine if the message requires access to
132-
/// the higher character limit available in Session Pro
131+
/// - `msg_size` -- the size of the message in UTF16 code units to determine if the message requires
132+
/// access to the higher character limit available in Session Pro
133133
/// - `flags` -- extra pro features that are known by clients that they wish to be activated on
134134
/// this message
135135
///
@@ -217,10 +217,6 @@ LIBSESSION_EXPORT void session_protocol_encrypt_for_destination_free(
217217
/// wraps an `Envelope` for 1o1 messages/sync messages, or `Envelope` encrypted using a Groups v2
218218
/// key) parse (or decrypt) the envelope and return the envelope content decrypted if necessary.
219219
///
220-
/// A groups v2 envelope will get decrypted with the group keys. A non-groups v2 envelope will get
221-
/// decrypted with the specified Ed25519 private key in the `keys` object. Only one of these keys
222-
/// need to be set depending on the type of envelope payload passed into the function.
223-
///
224220
/// See: session_protocol/decrypt_envelope for more information
225221
///
226222
/// The encryption result must be freed with `session_protocol_decrypt_envelope_free` when the

include/session/session_protocol.hpp

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ struct EncryptedForDestination {
163163
/// Determine the Pro features that are used in a given conversation message.
164164
///
165165
/// Inputs:
166-
/// - `msg_size` -- the size of the message in bytes to determine if the message requires access to
167-
/// the higher character limit available in Session Pro
166+
/// - `msg_size` -- the size of the message in UTF16 code units to determine if the message requires
167+
/// access to the higher character limit available in Session Pro
168168
/// - `flags` -- extra pro features that are known by clients that they wish to be activated on
169169
/// this message
170170
///
@@ -232,10 +232,9 @@ EncryptedForDestination encrypt_for_destination(
232232
/// decrypted with the specified Ed25519 private key in the `keys` object. Only one of these keys
233233
/// need to be set depending on the type of envelope payload passed into the function.
234234
///
235-
/// If the message does not use Session Pro features, the pro status will be set to nil and all
236-
/// other pro fields are to be ignored. If the pro status is non-nil then the pro fields will be
237-
/// populated with data about the Session Pro proof embedded in the envelope including the features
238-
/// used and if the proof was valid/expired e.t.c.
235+
/// If the message does not use Session Pro features, the `pro` object will be set to nil. Otherwise
236+
/// the pro fields will be populated with data about the Session Pro proof embedded in the envelope
237+
/// including the features used and if the proof was valid/expired e.t.c.
239238
///
240239
/// This function will throw if parsing failed such as a required field is missing, the field is
241240
/// smaller or larger than expected, decryption failed, or an invariant failed. Notably this

0 commit comments

Comments
 (0)