Browse Source

Small corrections, will go through in more detail later, but want to merge into master.

pull/22/head
Krista Bennett 1 year ago
parent
commit
6bbe96a61e
4 changed files with 15 additions and 12 deletions
  1. +1
    -1
      src/base64.c
  2. +12
    -9
      src/baseprotocol.h
  3. +1
    -1
      src/bloblist.c
  4. +1
    -1
      src/bloblist.h

+ 1
- 1
src/base64.c View File

@ -59,7 +59,7 @@ static bool _is_whitespace(const char in) {
*
* <!-- subtract_whitespace() -->
*
* @brief returns the lenght of the C string
* @brief returns the length of the C string
* not counting whitespaces
*
* @param[in] *input C string


+ 12
- 9
src/baseprotocol.h View File

@ -36,10 +36,12 @@ typedef enum _base_protocol_type {
/**
* <!-- base_decorate_message() -->
*
* @brief Decorate a message with payload
* @brief Given the data payload for an administrative message, add the appropriate
* information for the payload based on type and insert the payload into the
* message
*
* @param[in] session session handle
* @param[in,out] msg message to decorate (contains return result on success)
* @param[in,out] msg message to decorate
* @param[in] type base protocol type
* @param[in] payload payload to send
* @param[in] size size of payload
@ -67,7 +69,8 @@ PEP_STATUS base_decorate_message(
/**
* <!-- base_prepare_message() -->
*
* @brief Prepare a sync message with payload
* @brief Given a protocol data payload and a message type, prepare an administrative
* protocol message for encryption and/or delivery
*
* @param[in] session session handle
* @param[in] me identity to use for the sender
@ -104,7 +107,7 @@ PEP_STATUS base_prepare_message(
/**
* <!-- base_extract_message() -->
*
* @brief Extract a sync message from a pEp message
* @brief Extract protocol data from a pEp administrative message
*
* @param[in] session session handle
* @param[in] msg message to analyze
@ -115,7 +118,7 @@ PEP_STATUS base_prepare_message(
* @param[out] fpr if message was correctly signed then fpr of signature's
* key, otherwise NULL
*
* @retval PEP_STATUS_OK jif no error occurred, whether or not sync message was found
* @retval PEP_STATUS_OK if no error occurred, whether or not sync message was found
* @retval PEP_OUT_OF_MEMORY out of memory
* @retval PEP_ILLEGAL_VALUE illegal parameter values
* @retval error_status any other value on error
@ -141,10 +144,10 @@ PEP_STATUS base_extract_message(
/**
* <!-- try_base_prepare_message() -->
*
* @brief Prepare a sync message with payload. This is the internal function to be used by
* asynchronous network protocol implementations. This function differs from
* base_prepare_message in that it calls messageToSend(NULL) in case there is a missing
* or wrong passphrase, but more explanation is required here.
* @brief Prepare an administrative message with payload. This is the internal function to be used by
* asynchronous network protocol implementations. This function differs from
* base_prepare_message in that it calls messageToSend(NULL) in case there is a missing
* or wrong passphrase, but more explanation is required here.
*
* @param[in] session session handle
* @param[in] me identity to use for the sender


+ 1
- 1
src/bloblist.c View File

@ -1,7 +1,7 @@
/**
* @file bloblist.c
* @brief implemantation of functions for list structure to hold data of unspecified
* format (hence, "blob list"); can contain addition format information in structure's mime info
* format (hence, "blob list"); can contain additional format information in structure's mime info
* @license GNU General Public License 3.0 - see LICENSE.txt
*/


+ 1
- 1
src/bloblist.h View File

@ -1,7 +1,7 @@
/**
* @file bloblist.h
* @brief functions for list structure to hold data of unspecified format (hence,
* "blob list"); can contain addition format information in structure's mime info
* "blob list"); can contain additional format information in structure's mime info
* @license GNU General Public License 3.0 - see LICENSE.txt
*/


Loading…
Cancel
Save