pEp.foundation
/
pEpEngine
16
2
Fork 17
Code Issues 23 Pull Requests 2 Releases 48 Wiki Activity

Some syntax corrections in special comments for doxygen

Browse Source
pull/73/head
Gernot 1 year ago committed by Luca Saiu
parent 82ffc2342f
commit fde67db15e
18 changed files with 118 additions and 87 deletions
Show Stats Download Patch File Download Diff File

2
src/Doxyfile
Unescape Escape View File

@ -573,7 +573,7 @@ HIDE_IN_BODY_DOCS = NO
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
INTERNAL_DOCS = YES
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
# able to match the capabilities of the underlying filesystem. In case the

2
src/bloblist.c
Unescape Escape View File

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

20
src/etpan_mime.c
Unescape Escape View File

@ -2131,9 +2131,9 @@ pEp_error:
*
* @brief TODO
*
* @param[in] *msg constmessage
* @param[in] *msg const message
* @param[in] omit_fields bool
* @param[in] **result structmailmime
* @param[in] **result struct mailmime
*
* @retval PEP_STATUS_OK
* @retval PEP_OUT_OF_MEMORY out of memory
@ -2318,7 +2318,7 @@ pEp_error:
*
* @brief TODO
*
* @param[in] *mb conststructmailimf_mailbox
* @param[in] *mb const struct mailimf_mailbox
*
*/
static pEp_identity *mailbox_to_identity(const struct mailimf_mailbox * mb)
@ -2375,7 +2375,7 @@ enomem:
*
* @brief TODO
*
* @param[in] *mbl conststructmailimf_mailbox_list
* @param[in] *mbl const struct mailimf_mailbox_list
*
*/
static pEp_identity * mbl_to_identity(const struct mailimf_mailbox_list * mbl)
@ -2391,7 +2391,7 @@ static pEp_identity * mbl_to_identity(const struct mailimf_mailbox_list * mbl)
*
* @brief TODO
*
* @param[in] *mal conststructmailimf_address_list
* @param[in] *mal const struct mailimf_address_list
*
*/
static identity_list * mal_to_identity_list(
@ -2462,7 +2462,7 @@ enomem:
*
* @brief TODO
*
* @param[in] *list constclist
* @param[in] *list const clist
*
*/
static stringlist_t * clist_to_stringlist(const clist *list)
@ -2730,7 +2730,7 @@ pEp_error:
*
* @brief TODO
*
* @param[in] *part structmailmime
* @param[in] *part struct mailmime
* @param[in] **longmsg char
* @param[in] *size size_t
*
@ -2825,7 +2825,7 @@ static PEP_STATUS interpret_body(struct mailmime *part, char **longmsg, size_t *
*
* @brief TODO
*
* @param[in] *mime structmailmime
* @param[in] *mime struct mailmime
* @param[in] *msg message
*
*/
@ -2876,7 +2876,7 @@ static PEP_STATUS interpret_protected_headers(
*
* @brief TODO
*
* @param[in] *mime structmailmime
* @param[in] *mime struct mailmime
* @param[in] *msg message
*
* @retval PEP_STATUS_OK
@ -2977,7 +2977,7 @@ static bool _is_marked_as_attachment(struct mailmime_fields *fields)
*
* @brief TODO
*
* @param[in] *mime structmailmime
* @param[in] *mime struct mailmime
* @param[in] *msg message
* @param[in] *has_possible_pEp_msg bool
*

22
src/group.c
Unescape Escape View File

@ -1,5 +1,8 @@
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file group.c
* @brief Description for doxygen is missing (TODO)
* @license This file is under GNU General Public License 3.0 - see LICENSE.txt
*/
#include "group.h"
#include "group_internal.h"
@ -18,6 +21,12 @@
******************************************************************************************/
/******************************************************************************************
*
* @internal
*
* <!-- * _build_managed_group_message_payload -->
*
* @brief TODO
*
* @param session
* @param group_identity
@ -25,7 +34,8 @@
* @param data
* @param size
* @param managed_group_msg_type
* @return
* @retval PEP_STATUS_OK
* @retval any other on error
*/
static PEP_STATUS _build_managed_group_message_payload(PEP_SESSION session,
const pEp_identity* group_identity,
@ -99,6 +109,12 @@ pEp_error:
}
/******************************************************************************************
*
* @internal
*
* <!-- _create_and_send_managed_group_message -->
*
* @brief TODO
*
* @param session
* @param from

3
src/pEpEngine.c
Unescape Escape View File

@ -1,4 +1,5 @@
/** @file pEpEngine.c
/**
* @file pEpEngine.c
* @brief implementation of the pEp Engine API
* @license GNU General Public License 3.0 - see LICENSE.txt
*/

36
src/pEpEngine.h
Unescape Escape View File

@ -899,22 +899,22 @@ typedef unsigned int identity_flags_t;
*
*/
typedef struct _pEp_identity {
char *address; // C string with address UTF-8 encoded
char *fpr; // C string with fingerprint UTF-8 encoded
char *user_id; // C string with user ID UTF-8 encoded
// user_id MIGHT be set to "pEp_own_userId"
// (use PEP_OWN_USERID preprocessor define)
// if this is own user's identity.
// But it is not REQUIRED to be.
char *username; // C string with user name UTF-8 encoded
PEP_comm_type comm_type; // type of communication with this ID
char lang[3]; // language of conversation
// ISO 639-1 ALPHA-2, last byte is 0
bool me; // if this is the local user herself/himself
unsigned int major_ver; // highest version of pEp message received, if any
unsigned int minor_ver; // highest version of pEp message received, if any
PEP_enc_format enc_format; // Last specified format we encrypted to for this identity
identity_flags_t flags; // identity_flag1 | identity_flag2 | ...
char *address; ///< C string with address UTF-8 encoded
char *fpr; ///< C string with fingerprint UTF-8 encoded
char *user_id; ///< C string with user ID UTF-8 encoded\n
///< user_id MIGHT be set to "pEp_own_userId"
///< (use PEP_OWN_USERID preprocessor define)
///< if this is own user's identity.
///< But it is not REQUIRED to be.
char *username; ///< C string with user name UTF-8 encoded
PEP_comm_type comm_type; ///< type of communication with this ID
char lang[3]; ///< language of conversation
///< ISO 639-1 ALPHA-2, last byte is 0
bool me; ///< if this is the local user herself/himself
unsigned int major_ver; ///< highest version of pEp message received, if any
unsigned int minor_ver; ///< highest version of pEp message received, if any
PEP_enc_format enc_format; ///< Last specified format we encrypted to for this identity
identity_flags_t flags; ///< identity_flag1 | identity_flag2 | ...
} pEp_identity;
/**
@ -924,8 +924,8 @@ typedef struct _pEp_identity {
*
*/
typedef struct _identity_list {
pEp_identity *ident; // This node's identity
struct _identity_list *next; // The next identity node in the list, or NULL if this is the tail
pEp_identity *ident; ///< This node's identity
struct _identity_list *next; ///< The next identity node in the list, or NULL if this is the tail
} identity_list;

11
src/pgp_netpgp.c
Unescape Escape View File

@ -1,9 +1,12 @@
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file pgp_netpgp.c
* @brief Implementation of NetPGP
* @license This file is under GNU General Public License 3.0 see LICENSE.txt
*/
/*
** Check to see if this machine uses EBCDIC. (Yes, believe it or
** not, there are still machines out there that use EBCDIC.)
* Check to see if this machine uses EBCDIC. (Yes, believe it or
* not, there are still machines out there that use EBCDIC.)
*/
#if 'A' == '\301'
# define NETPGP_EBCDIC 1

10
src/platform_unix.c
Unescape Escape View File

@ -1,8 +1,8 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file platform_unix.c
* @brief File description for doxygen missing. FIXME
* @license This file is under GNU General Public License 3.0. - see LICENSE.txt
*/
#ifndef __MVS__
#define _POSIX_C_SOURCE 200809L

7
src/platform_zos.c
Unescape Escape View File

@ -1,5 +1,8 @@
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file platform_zos.c
* @license This file is under GNU General Public License 3.0. - see LICENSE.txt
* @brief Nothing useful here at this time.
*/
/* Include the entire useful part of this compilation unit within a CPP
conditional, so that the entire file expands to nothing if this is not

11
src/resource_id.c
Unescape Escape View File

@ -1,8 +1,9 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file resource_id.c
* @brief File description for doxygen missing. FIXME
* @license This file is under GNU General Public License 3.0
* see LICENSE.txt
*/
#include "pEp_internal.h"
#include "resource_id.h"

11
src/security_checks.c
Unescape Escape View File

@ -1,7 +1,8 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file security_checks.c
* @brief Security checks (whatever is meant to be here is not yet implemented)
*
* @license This file is under GNU General Public License 3.0 - see LICENSE.txt
*/
#include "pEp_internal.h"

6
src/sqlite3.c
Unescape Escape View File

@ -1,5 +1,7 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
/**
* @file sqlite3.c
* @brief This file is an amalgamation of many separate C source files from SQLite
* version 3.36.0. */
/******************************************************************************
** This file is an amalgamation of many separate C source files from SQLite

11
src/stringlist.c
Unescape Escape View File

@ -1,8 +1,9 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file stringlist.c
* @brief File description for doxygen missing. FIXME
* @license This file is under GNU General Public License 3.0
* see LICENSE.txt
*/
#include "pEp_internal.h"

12
src/stringpair.c
Unescape Escape View File

@ -1,8 +1,10 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file stringpair.c
* @brief File description for doxygen missing. FIXME
*
* @license This file is under GNU General Public License 3.0
* see LICENSE.txt
*/
#include "pEp_internal.h"

11
src/sync_api.c
Unescape Escape View File

@ -1,8 +1,9 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file sync_api.c
* @brief File description for doxygen missing. FIXME
* @license This file is under GNU General Public License 3.0
* see LICENSE.txt
*/
#include "pEp_internal.h"

10
src/timestamp.c
Unescape Escape View File

@ -1,8 +1,8 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file timestamp.c
* @brief File description for doxygen missing. FIXME
* @license This file is under GNU General Public License 3.0 - see LICENSE.txt
*/
#include "pEp_internal.h"

10
src/trans_auto.c
Unescape Escape View File

@ -1,8 +1,8 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file trans_auto.c
* @brief File description for doxygen missing. FIXME
* This file is under GNU General Public License 3.0 - see LICENSE.txt
*/
#include "trans_auto.h"

10
src/transport.c
Unescape Escape View File

@ -1,8 +1,8 @@
/** @file */
/** @brief File description for doxygen missing. FIXME */
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/**
* @file transport.c
* @brief File description for doxygen missing. FIXME
* This file is under GNU General Public License 3.0 - see LICENSE.txt
*/
#include "pEp_internal.h"
#include "trans_auto.h"

Write Preview
Loading…
Cancel
Save