Browse Source

More doc blocks added by script.

doxygen-key-id
parent
commit
645ac77a4e
21 changed files with 302 additions and 0 deletions
  1. +6
    -0
      src/bloblist.h
  2. +24
    -0
      src/cryptotech.h
  3. +7
    -0
      src/etpan_mime.h
  4. +6
    -0
      src/growing_buf.h
  5. +8
    -0
      src/key_reset.h
  6. +8
    -0
      src/keymanagement.h
  7. +12
    -0
      src/keyreset_command.h
  8. +6
    -0
      src/labeled_int_list.h
  9. +12
    -0
      src/message.h
  10. +29
    -0
      src/pEpEngine.h
  11. +35
    -0
      src/pEp_internal.h
  12. +27
    -0
      src/pgp_sequoia.h
  13. +15
    -0
      src/platform_unix.h
  14. +45
    -0
      src/platform_windows.h
  15. +6
    -0
      src/resource_id.h
  16. +16
    -0
      src/status_to_string.h
  17. +6
    -0
      src/stringlist.h
  18. +12
    -0
      src/stringpair.h
  19. +8
    -0
      src/sync_api.h
  20. +6
    -0
      src/transport.h
  21. +8
    -0
      src/wrappers.h

+ 6
- 0
src/bloblist.h View File

@ -22,6 +22,12 @@ typedef enum {
PEP_CONTENT_DISP_OTHER = -1 // must be affirmatively set
} content_disposition_type;
/**
* @struct bloblist_t
*
* @brief TODO
*
*/
typedef struct _bloblist_t {
char *value; // blob
size_t size; // size of blob


+ 24
- 0
src/cryptotech.h View File

@ -214,6 +214,12 @@ typedef PEP_STATUS (*config_cipher_suite_t)(PEP_SESSION session,
PEP_CIPHER_SUITE suite);
/**
* @struct PEP_cryptotech_t
*
* @brief TODO
*
*/
typedef struct _PEP_cryptotech_t {
uint8_t id;
// the following are default values; comm_type may vary with key length or b0rken crypto
@ -247,5 +253,23 @@ extern PEP_cryptotech_t cryptotech[PEP_crypt__count];
typedef uint64_t cryptotech_mask;
/**
* <!-- init_cryptotech() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] in_first bool
*
*/
PEP_STATUS init_cryptotech(PEP_SESSION session, bool in_first);
/**
* <!-- release_cryptotech() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] out_last bool
*
*/
void release_cryptotech(PEP_SESSION session, bool out_last);

+ 7
- 0
src/etpan_mime.h View File

@ -23,6 +23,13 @@ struct mailmime * part_new_empty(
int force_single
);
/**
* <!-- get_pgp_encrypted_part() -->
*
* @brief TODO
*
*
*/
struct mailmime * get_pgp_encrypted_part(void);
struct mailmime * get_text_part(


+ 6
- 0
src/growing_buf.h View File

@ -19,6 +19,12 @@ extern "C" {
// this is a growing buffer, which is needed by the ASN.1 implementation
// i.e. for encoding to XER
/**
* @struct growing_buf_t
*
* @brief TODO
*
*/
typedef struct growing_buf {
char *data;
size_t size;


+ 8
- 0
src/key_reset.h View File

@ -102,6 +102,14 @@ DYNAMIC_API PEP_STATUS key_reset_all_own_keys(PEP_SESSION session);
// FIXME: Doc
// This is simply NOT SAFE for multiple passwords on the extant
// keys. Cannot be called with multiple passwords for that purpose.
/**
* <!-- key_reset_own_grouped_keys() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
*
*/
DYNAMIC_API PEP_STATUS key_reset_own_grouped_keys(PEP_SESSION session);
/**


+ 8
- 0
src/keymanagement.h View File

@ -452,6 +452,14 @@ DYNAMIC_API PEP_STATUS set_own_key(
// but passphrase is the wrong one
// Otherwise, database and keyring errors as appropriate
//
/**
* <!-- clean_own_key_defaults() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
*
*/
DYNAMIC_API PEP_STATUS clean_own_key_defaults(PEP_SESSION session);
PEP_STATUS get_all_keys_for_user(PEP_SESSION session,


+ 12
- 0
src/keyreset_command.h View File

@ -13,6 +13,12 @@
extern "C" {
#endif
/**
* @struct keyreset_command
*
* @brief TODO
*
*/
typedef struct _keyreset_command {
pEp_identity * ident;
char * new_key;
@ -63,6 +69,12 @@ DYNAMIC_API void free_keyreset_command(keyreset_command * command);
DYNAMIC_API keyreset_command * keyreset_command_dup(const keyreset_command * src);
/**
* @struct keyreset_command_list
*
* @brief TODO
*
*/
typedef struct _keyreset_command_list {
keyreset_command * command;
struct _keyreset_command_list * next;


+ 6
- 0
src/labeled_int_list.h View File

@ -13,6 +13,12 @@
extern "C" {
#endif
/**
* @struct labeled_int_list_t
*
* @brief TODO
*
*/
typedef struct _labeled_int_list_t {
int value;
char* label; // UTF-8 string, null-terminated


+ 12
- 0
src/message.h View File

@ -35,6 +35,12 @@ typedef enum _PEP_msg_direction {
struct _message_ref_list;
/**
* @struct message
*
* @brief TODO
*
*/
typedef struct _message {
PEP_msg_direction dir;
char *id; // UTF-8 string of message ID
@ -70,6 +76,12 @@ typedef struct _message {
// (read_only to the outside)
} message;
/**
* @struct message_ref_list
*
* @brief TODO
*
*/
typedef struct _message_ref_list {
message *msg_ref; // reference to message
struct _message_ref_list *next;


+ 29
- 0
src/pEpEngine.h View File

@ -492,6 +492,15 @@ DYNAMIC_API PEP_STATUS encrypt_and_sign(
);
/**
* <!-- set_debug_color() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] ansi_color int
*
*/
DYNAMIC_API void set_debug_color(PEP_SESSION session, int ansi_color);
/**
@ -681,6 +690,12 @@ typedef unsigned int identity_flags_t;
typedef unsigned int keypair_flags_t;
/**
* @struct pEp_identity
*
* @brief TODO
*
*/
typedef struct _pEp_identity {
char *address; // C string with address UTF-8 encoded
char *fpr; // C string with fingerprint UTF-8 encoded
@ -700,6 +715,12 @@ typedef struct _pEp_identity {
identity_flags_t flags; // identity_flag1 | identity_flag2 | ...
} pEp_identity;
/**
* @struct identity_list
*
* @brief TODO
*
*/
typedef struct _identity_list {
pEp_identity *ident;
struct _identity_list *next;
@ -1727,6 +1748,14 @@ PEP_STATUS _generate_keypair(PEP_SESSION session,
pEp_identity *identity,
bool suppress_event);
/**
* <!-- reset_pEptest_hack() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
*
*/
DYNAMIC_API PEP_STATUS reset_pEptest_hack(PEP_SESSION session);
// This is used internally when there is a temporary identity to be retrieved


+ 35
- 0
src/pEp_internal.h View File

@ -115,6 +115,12 @@
struct _pEpSession;
typedef struct _pEpSession pEpSession;
/**
* @struct _pEpSession
*
* @brief TODO
*
*/
struct _pEpSession {
const char *version;
messageToSend_t messageToSend;
@ -277,7 +283,25 @@ struct _pEpSession {
};
/**
* <!-- init_transport_system() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] in_first bool
*
*/
PEP_STATUS init_transport_system(PEP_SESSION session, bool in_first);
/**
* <!-- release_transport_system() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] out_last bool
*
*/
void release_transport_system(PEP_SESSION session, bool out_last);
/* NOT to be exposed to the outside!!! */
@ -484,6 +508,17 @@ static inline void pEp_version_major_minor(const char* version_str, unsigned int
return;
}
/**
* <!-- compare_versions() -->
*
* @brief TODO
*
* @param[in] first_maj unsignedint
* @param[in] first_min unsignedint
* @param[in] second_maj unsignedint
* @param[in] second_min unsignedint
*
*/
static inline int compare_versions(unsigned int first_maj, unsigned int first_min,
unsigned int second_maj, unsigned int second_min) {
if (first_maj > second_maj)


+ 27
- 0
src/pgp_sequoia.h View File

@ -8,7 +8,25 @@
#include "pEpEngine.h"
/**
* <!-- pgp_init() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] in_first bool
*
*/
PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
/**
* <!-- pgp_release() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] out_last bool
*
*/
void pgp_release(PEP_SESSION session, bool out_last);
PEP_STATUS pgp_decrypt_and_verify(
@ -117,6 +135,15 @@ PEP_STATUS pgp_find_private_keys(
PEP_STATUS pgp_binary(const char **path);
/**
* <!-- pgp_config_cipher_suite() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] suite PEP_CIPHER_SUITE
*
*/
PEP_STATUS pgp_config_cipher_suite(PEP_SESSION session,
PEP_CIPHER_SUITE suite);


+ 15
- 0
src/platform_unix.h View File

@ -41,8 +41,23 @@ extern "C" {
#ifdef NDEBUG
const char *unix_local_db(void);
#else
/**
* <!-- unix_local_db() -->
*
* @brief TODO
*
* @param[in] reset int
*
*/
const char *unix_local_db(int reset);
#endif
/**
* <!-- unix_system_db() -->
*
* @brief TODO
*
*
*/
const char *unix_system_db(void);


+ 45
- 0
src/platform_windows.h View File

@ -96,12 +96,40 @@ size_t strlcat(char* dst, const char* src, size_t size);
char *strnstr(const char *big, const char *little, size_t len);
/**
* <!-- windoze_keys_db() -->
*
* @brief TODO
*
*
*/
const char *windoze_keys_db(void);
/**
* <!-- windoze_local_db() -->
*
* @brief TODO
*
*
*/
const char *windoze_local_db(void);
/**
* <!-- windoze_system_db() -->
*
* @brief TODO
*
*
*/
const char *windoze_system_db(void);
void log_output_debug(const char *title, const char *entity, const char *description, const char *comment);
/**
* <!-- random() -->
*
* @brief TODO
*
*
*/
long random(void);
// on Windoze, uuid_t needs pointer semantics
@ -109,8 +137,25 @@ typedef UUID pEpUUID[1];
#define _UUID_STRING_T
typedef char uuid_string_t[37];
/**
* <!-- uuid_generate_random() -->
*
* @brief TODO
*
* @param[in] out pEpUUID
*
*/
void uuid_generate_random(pEpUUID out);
int uuid_parse(char *in, pEpUUID uu);
/**
* <!-- uuid_unparse_upper() -->
*
* @brief TODO
*
* @param[in] uu pEpUUID
* @param[in] out uuid_string_t
*
*/
void uuid_unparse_upper(pEpUUID uu, uuid_string_t out);
#ifndef __cplusplus


+ 6
- 0
src/resource_id.h View File

@ -14,6 +14,12 @@ typedef enum _resource_id_type {
typedef struct pEp_rid_list_t pEp_rid_list_t;
/**
* @struct pEp_rid_list_t
*
* @brief TODO
*
*/
struct pEp_rid_list_t {
pEp_resource_id_type rid_type;
char* rid;


+ 16
- 0
src/status_to_string.h View File

@ -12,6 +12,14 @@ extern "C" {
#define PEP_STATUS_TO_STRING
#endif
/**
* <!-- pEp_status_to_string() -->
*
* @brief TODO
*
* @param[in] status PEP_STATUS
*
*/
static inline const char *pEp_status_to_string(PEP_STATUS status) {
switch (status) {
case PEP_STATUS_OK: return "PEP_STATUS_OK";
@ -118,6 +126,14 @@ static inline const char *pEp_status_to_string(PEP_STATUS status) {
}
}
/**
* <!-- pEp_comm_type_to_string() -->
*
* @brief TODO
*
* @param[in] ct PEP_comm_type
*
*/
static inline const char *pEp_comm_type_to_string(PEP_comm_type ct) {
switch (ct) {
case PEP_ct_unknown: return "unknown";


+ 6
- 0
src/stringlist.h View File

@ -13,6 +13,12 @@ extern "C" {
#endif
/**
* @struct stringlist_t
*
* @brief TODO
*
*/
typedef struct _stringlist_t {
char *value;
struct _stringlist_t *next;


+ 12
- 0
src/stringpair.h View File

@ -13,6 +13,12 @@ extern "C" {
#endif
/**
* @struct stringpair_t
*
* @brief TODO
*
*/
typedef struct _stringpair_t {
char * key; // may point to "" but must not be NULL!
char * value; // may point to "" but must not be NULL!
@ -64,6 +70,12 @@ DYNAMIC_API void free_stringpair(stringpair_t * pair);
DYNAMIC_API stringpair_t * stringpair_dup(const stringpair_t *src);
/**
* @struct stringpair_list_t
*
* @brief TODO
*
*/
typedef struct _stringpair_list_t {
stringpair_t *value;
struct _stringpair_list_t *next;


+ 8
- 0
src/sync_api.h View File

@ -153,6 +153,14 @@ DYNAMIC_API PEP_STATUS register_sync_callbacks(
retrieve_next_sync_event_t retrieve_next_sync_event
);
/**
* <!-- unregister_sync_callbacks() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
*
*/
DYNAMIC_API void unregister_sync_callbacks(PEP_SESSION session);


+ 6
- 0
src/transport.h View File

@ -28,6 +28,12 @@ typedef PEP_STATUS (*sendto_t)(PEP_SESSION session, const message *msg);
typedef PEP_STATUS (*readnext_t)(PEP_SESSION session, message **msg,
PEP_transport_t **via);
/**
* @struct _PEP_transport_t
*
* @brief TODO
*
*/
struct _PEP_transport_t {
uint8_t id; // transport ID
sendto_t sendto; // sendto function


+ 8
- 0
src/wrappers.h View File

@ -149,6 +149,14 @@ static inline int Mkstemp(char *template)
return fd;
}
/**
* <!-- Close() -->
*
* @brief TODO
*
* @param[in] fildes int
*
*/
static inline int Close(int fildes)
{
int r;


Loading…
Cancel
Save