Most compilation errors of doxygen solved

pull/73/head
Gernot 1 year ago committed by Luca Saiu
parent 99653efb5c
commit ef5260152e

@ -53,7 +53,7 @@ PROJECT_BRIEF =
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO = ./doc/logo.png
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
@ -826,7 +826,8 @@ WARNINGS = YES
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
## nondefault
WARN_IF_UNDOCUMENTED = NO
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as documenting some parameters in
@ -926,7 +927,7 @@ FILE_PATTERNS = *.c \
*.h \
# *.cc \
# *.cxx \
# *.cpp \
*.cpp \
# *.c++ \
# *.java \
# *.ii \
@ -1197,13 +1198,6 @@ VERBATIM_HEADERS = YES
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
@ -2293,7 +2287,9 @@ PREDEFINED = ENIGMAIL_MAY_USE_THIS \
USE_SEQUOIA \
_PEP_SQLITE_DEBUG \
DYNAMIC_API= \
PREDEFINED MAYBE_UNUSED=
MAYBE_UNUSED=\
__attribute__((__unused__))=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The

@ -217,17 +217,17 @@ static int table_contains_column(PEP_SESSION session, const char* table_name,
return retval;
}
#define _PEP_MAX_AFFECTED 5
/**
* @internal
*
* <!-- repair_altered_tables() -->
* <!-- repair_altered_tables() -->
*
* @brief TODO
*
* @param[in] session PEP_SESSION
*
*/
#define _PEP_MAX_AFFECTED 5
PEP_STATUS repair_altered_tables(PEP_SESSION session) {
PEP_STATUS status = PEP_STATUS_OK;

@ -242,7 +242,7 @@ DYNAMIC_API PEP_STATUS group_create(
PEP_SESSION session,
pEp_identity *group_identity,
pEp_identity *manager,
identity_list *memberlist,
identity_list *member_ident_list,
pEp_group **group
);

@ -36,7 +36,7 @@ DYNAMIC_API identity_list *new_identity_list(pEp_identity *ident);
*
* @brief Duplicate identity_list (deep copy)
*
* @param[in] id_list identity_list to copy
* @param[in] src identity_list to copy
*
* @retval new identity_list or NULL if out of memory
*

@ -56,7 +56,7 @@ DYNAMIC_API PEP_STATUS encode_internal(
*
* @param[in] code blob in Internal Message Format
* @param[in] code_size size of code
* @param[in] tech crypto tech for MIME type, PEP_crypt_none for auto
* <!-- @param[in] tech crypto tech for MIME type, PEP_crypt_none for auto. Not in function declaration -->
* @param[out] value blob or string for longmsg
* @param[out] size size of value
* @param[out] mime_type string with MIME type or NULL for longmsg

@ -30,8 +30,8 @@ extern "C" {
*
* @brief Convert pEp_identity into ASN.1 PIdentity_t
*
* @param ident[in] pEp_identity to convert
* @param result[in,out] PIdentity_t to update or NULL to alloc a new one
* @param[in] ident pEp_identity to convert
* @param[in,out] result PIdentity_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -50,8 +50,8 @@ PIdentity_t *PIdentity_from_Struct(
*
* @brief Convert ASN.1 PIdentity_t into pEp_identity
*
* @param ident[in] PIdentity_t to convert
* @param result[inout] pEp_identity to update or NULL to alloc a new one
* @param[in] ident PIdentity_t to convert
* @param[in,out] result pEp_identity to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -67,8 +67,8 @@ pEp_identity *PIdentity_to_Struct(PIdentity_t *ident, pEp_identity *result);
*
* @brief Convert identity_list_t into ASN.1 PIdentityList_t
*
* @param list[in] identity_list to convert
* @param result[inout] PIdentityList_t to update or NULL to alloc a new one
* @param[in] list identity_list to convert
* @param[inout] result PIdentityList_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -86,8 +86,8 @@ PIdentityList_t *PIdentityList_from_identity_list(
*
* @brief Convert ASN.1 PIdentityList_t to identity_list_t
*
* @param list[in] ASN.1 PIdentityList_t to convert
* @param result[inout] identity_list_t to update or NULL to alloc a new one
* @param[in] list ASN.1 PIdentityList_t to convert
* @param[in,out] result identity_list_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -103,8 +103,8 @@ identity_list *PIdentityList_to_identity_list(PIdentityList_t *list, identity_li
*
* @brief Convert pEp_identity into ASN.1 Identity_t
*
* @param ident[in] pEp_identity to convert
* @param result[in,out] Identity_t to update or NULL to alloc a new one
* @param[in] ident pEp_identity to convert
* @param[in,out] result Identity_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -123,8 +123,8 @@ Identity_t *Identity_from_Struct(
*
* @brief Convert ASN.1 Identity_t into pEp_identity
*
* @param ident[in] Identity_t to convert
* @param result[inout] pEp_identity to update or NULL to alloc a new one
* @param[in] ident Identity_t to convert
* @param[in,out] result pEp_identity to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -140,8 +140,8 @@ pEp_identity *Identity_to_Struct(Identity_t *ident, pEp_identity *result);
*
* @brief Convert identity_list_t into ASN.1 IdentityList_t
*
* @param list[in] identity_list to convert
* @param result[inout] IdentityList_t to update or NULL to alloc a new one
* @param[in] list identity_list to convert
* @param[in,out] result IdentityList_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -159,8 +159,8 @@ IdentityList_t *IdentityList_from_identity_list(
*
* @brief Convert ASN.1 IdentityList_t to identity_list_t
*
* @param list[in] ASN.1 IdentityList_t to convert
* @param result[inout] identity_list_t to update or NULL to alloc a new one
* @param[in] list ASN.1 IdentityList_t to convert
* @param[in,out] result identity_list_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -176,8 +176,8 @@ identity_list *IdentityList_to_identity_list(IdentityList_t *list, identity_list
*
* @brief Convert stringpair_t into ASN.1 PStringPair_t
*
* @param value[in] stringpair_t to convert
* @param result[in,out] PStringPair_t to update or NULL to alloc a new one
* @param[in] value stringpair_t to convert
* @param[in,out] result PStringPair_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -196,7 +196,7 @@ PStringPair_t *PStringPair_from_Struct(
*
* @brief Convert ASN.1 PStringPair_t into stringpair_t
*
* @param value[in] PStringPair_t to convert
* @param[in] value PStringPair_t to convert
*
* @retval pointer to updated or allocated result
*
@ -212,8 +212,8 @@ stringpair_t *PStringPair_to_Struct(PStringPair_t *value);
*
* @brief Convert stringpair_list_t into ASN.1 PStringPairList_t
*
* @param list[in] stringpair_list to convert
* @param result[inout] PStringPairList_t to update or NULL to alloc a new one
* @param[in] list stringpair_list to convert
* @param[in,out] result PStringPairList_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -231,8 +231,8 @@ PStringPairList_t *PStringPairList_from_stringpair_list(
*
* @brief Convert ASN.1 PStringPairList_t to stringpair_list_t
*
* @param list[in] ASN.1 PStringPairList_t to convert
* @param result[inout] stringpair_list_t to update or NULL to alloc a new one
* @param[in] list ASN.1 PStringPairList_t to convert
* @param[in,out] result stringpair_list_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -251,8 +251,8 @@ stringpair_list_t *PStringPairList_to_stringpair_list(
*
* @brief Convert stringlist_t into ASN.1 PStringList_t
*
* @param list[in] stringlist to convert
* @param result[inout] PStringList_t to update or NULL to alloc a new one
* @param[in] list stringlist to convert
* @param[in,out] result PStringList_t to update or NULL to alloc a new one
*
* @retval pointer to updated or allocated result
*
@ -270,7 +270,7 @@ PStringList_t *PStringList_from_stringlist(
*
* @brief Convert ASN.1 PStringList_t to stringlist_t
*
* @param list[in] ASN.1 PStringList_t to convert
* @param[in] list ASN.1 PStringList_t to convert
*
* @retval pointer to updated or allocated result
*
@ -286,11 +286,11 @@ stringlist_t *PStringList_to_stringlist(PStringList_t *list);
*
* @brief Convert bloblist_t into ASN.1 PBlobList_t
*
* @param list[in] bloblist to convert
* @param result[inout] PBlobList_t to update or NULL to alloc a new one
* @param copy copy data if true, move data otherwise
* @param max_blob_size reject if sum(blob.size) > max_blob_size
* to disable set to 0
* @param[in] list bloblist to convert
* @param[in,out] result PBlobList_t to update or NULL to alloc a new one
* @param copy copy data if true, move data otherwise
* @param max_blob_size reject if sum(blob.size) > max_blob_size
* to disable set to 0
*
* @retval pointer to updated or allocated result
*
@ -311,11 +311,11 @@ PBlobList_t *PBlobList_from_bloblist(
*
* @brief Convert ASN.1 PBlobList_t to bloblist_t
*
* @param list[in] ASN.1 PBlobList_t to convert
* @param result[inout] bloblist_t to update or NULL to alloc a new one
* @param copy copy data if true, move data otherwise
* @param max_blob_size reject if sum(blob.size) > max_blob_size
* to disable set to 0
* @param[in] list ASN.1 PBlobList_t to convert
* @param[in,out] result bloblist_t to update or NULL to alloc a new one
* @param copy copy data if true, move data otherwise
* @param max_blob_size reject if sum(blob.size) > max_blob_size
* to disable set to 0
*
* @retval pointer to updated or allocated result
*
@ -336,8 +336,8 @@ bloblist_t *PBlobList_to_bloblist(
*
* @brief Convert message into ASN.1 ASN1Message_t
*
* @param msg[in] message to convert
* @param result[inout] ASN1Message_t to update or NULL to alloc a new one
* @param[in] msg message to convert
* @param[in,out] result ASN1Message_t to update or NULL to alloc a new one
* @param copy copy data if true, move data otherwise
* @param max_blob_size reject if sum(blob.size) > max_blob_size
* to disable set to 0
@ -362,11 +362,11 @@ ASN1Message_t *ASN1Message_from_message(
*
* @brief Convert ASN.1 ASN1Message_t to message
*
* @param msg[in] ASN.1 ASN1Message_t to convert
* @param result[inout] message to update or NULL to alloc a new one
* @param copy copy data if true, move data otherwise
* @param max_blob_size reject if sum(blob.size) > max_blob_size
* to disable set to 0
* @param[in] msg ASN.1 ASN1Message_t to convert
* @param[in,out] result message to update or NULL to alloc a new one
* @param copy copy data if true, move data otherwise
* @param max_blob_size reject if sum(blob.size) > max_blob_size
* to disable set to 0
*
* @retval pointer to updated or allocated result
*

@ -46,7 +46,7 @@ double _pEp_log2_36;
*
* @brief TODO
*
* @param[in] *msg constmessage
* @param[in] *msg const message
*
* @retval bool
*/
@ -66,7 +66,7 @@ static bool is_a_pEpmessage(const message *msg)
*
* @brief TODO
*
* @param[in] *keylist conststringlist_t
* @param[in] *keylist const stringlist_t
*
*/
static char * keylist_to_string(const stringlist_t *keylist)
@ -147,9 +147,9 @@ static const char * rating_to_string(PEP_rating rating)
*
* @brief TODO
*
* @param[in] *needle constchar
* @param[in] *needle const char
* @param[in] needle_size size_t
* @param[in] *haystack constchar
* @param[in] *haystack const char
* @param[in] haystack_size size_t
*
*/
@ -219,8 +219,8 @@ void add_opt_field(message *msg, const char *name, const char *value)
* @brief TODO
*
* @param[in] *msg message
* @param[in] *name constchar
* @param[in] *value constchar
* @param[in] *name const char
* @param[in] *value const char
* @param[in] clobber bool
*
*/
@ -461,8 +461,8 @@ static bool string_equality(const char *s1, const char *s2)
*
* @brief TODO
*
* @param[in] *bl constbloblist_t
* @param[in] *mt constchar
* @param[in] *bl const bloblist_t
* @param[in] *mt const char
*
* @retval bool
*/
@ -486,10 +486,9 @@ static bool is_mime_type(const bloblist_t *bl, const char *mt)
*
* @brief TODO
*
* @param[in] *bl constbloblist_t
* @param[in] *fe constchar
* @param[in] *bl const bloblist_t
* @param[in] *fe const char
*
* @retval
*/
static bool is_fileending(const bloblist_t *bl, const char *fe)
{
@ -518,8 +517,8 @@ static bool is_fileending(const bloblist_t *bl, const char *fe)
*
* @brief TODO
*
* @param[in] *msg_wrap_info constchar
* @param[in] *longmsg constchar
* @param[in] *msg_wrap_info const char
* @param[in] *longmsg const char
*
*/
char * encapsulate_message_wrap_info(const char *msg_wrap_info, const char *longmsg)
@ -563,8 +562,8 @@ char * encapsulate_message_wrap_info(const char *msg_wrap_info, const char *long
*
* @brief TODO
*
* @param[in] *shortmsg constchar
* @param[in] *longmsg constchar
* @param[in] *shortmsg const char
* @param[in] *longmsg const char
*
*/
static char * combine_short_and_long(const char *shortmsg, const char *longmsg)
@ -873,9 +872,9 @@ enomem:
*
* @brief TODO
*
* @param[in] *plaintext constchar
* @param[in] *key constchar
* @param[in] keylen constsize_t
* @param[in] *plaintext const char
* @param[in] *key const char
* @param[in] keylen const size_t
* @param[in] **data char
* @param[in] **modified_msg char
*
@ -932,7 +931,7 @@ static PEP_STATUS get_data_from_encapsulated_line(const char* plaintext, const c
*
* @brief TODO
*
* @param[in] *src constchar
* @param[in] *src const char
* @param[in] **shortmsg char
* @param[in] **msg_wrap_info char
* @param[in] **longmsg char
@ -1013,7 +1012,7 @@ enomem:
* @brief TODO
*
* @param[in] *dst message
* @param[in] *src constmessage
* @param[in] *src const message
*
* @retval PEP_STATUS_OK
* @retval PEP_ILLEGAL_VALUE illegal parameter values
@ -1143,7 +1142,7 @@ static PEP_STATUS copy_fields(message *dst, const message *src)
*
* @brief TODO
*
* @param[in] *src constmessage
* @param[in] *src const message
* @param[in] direct PEP_msg_direction
*
*/
@ -1218,7 +1217,7 @@ enomem:
*
* @brief TODO
*
* @param[in] *src constmessage
* @param[in] *src const message
*
*/
static message * clone_to_empty_message(const message * src)
@ -1411,7 +1410,7 @@ pEp_error:
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] *src constmessage
* @param[in] *src const message
* @param[in] *keys stringlist_t
* @param[in] *dst message
* @param[in] flags PEP_encrypt_flags_t
@ -1549,7 +1548,7 @@ static PEP_STATUS encrypt_PGP_inline(
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] *src constmessage
* @param[in] *src const message
* @param[in] *keys stringlist_t
* @param[in] *dst message
* @param[in] flags PEP_encrypt_flags_t
@ -1710,7 +1709,7 @@ DYNAMIC_API PEP_rating rating_from_comm_type(PEP_comm_type ct)
*
* @brief TODO
*
* @param[in] *blob constbloblist_t
* @param[in] *blob const bloblist_t
*
* @retval bool
*/
@ -1750,7 +1749,7 @@ static bool is_encrypted_attachment(const bloblist_t *blob)
*
* @brief TODO
*
* @param[in] *blob constbloblist_t
* @param[in] *blob const bloblist_t
*
* @retval bool
*/
@ -1779,7 +1778,7 @@ static bool is_encrypted_html_attachment(const bloblist_t *blob)
*
* @brief TODO
*
* @param[in] *filename constchar
* @param[in] *filename const char
*
*/
static char * without_double_ending(const char *filename)
@ -1845,7 +1844,7 @@ static PEP_rating decrypt_rating(PEP_STATUS status)
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] *fpr constchar
* @param[in] *fpr const char
*
*/
static PEP_rating key_rating(PEP_SESSION session, const char *fpr)
@ -2059,7 +2058,7 @@ static PEP_comm_type _get_comm_type_preview(
*
* @brief TODO
*
* @param[in] *bl constbloblist_t
* @param[in] *bl const bloblist_t
*
* @retval bool
*/
@ -2113,8 +2112,8 @@ static bool is_key(const bloblist_t *bl)
*
* @brief TODO
*
* @param[in] *first constchar
* @param[in] *second constchar
* @param[in] *first const char
* @param[in] *second const char
* @param[in] n size_t
*
*/
@ -2146,11 +2145,13 @@ static bool compare_first_n_bytes(const char* first, const char* second, size_t
*
* @brief TODO
*
* @param[in] session session handle
* @param[in] *msg message
* @param[in] **private_idents identity_list
* @param[in] **imported_key_list stringlist_t
* @param[in] *changed_keys uint64_t
* <!-- @param[in] session session handle
* @param[in] msg message*
* @param[in] is_pEp_msg bool
* @param[in] private_idents identity_list**
* @param[in] imported_key_list stringlist_t**
* @param[in] changed_keys uint64_t* -->
* @param[in,out] pEp_sender_key char**
*
* @retval bool
*/
@ -2325,7 +2326,7 @@ bool import_attached_keys(
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] *fpr constchar
* @param[in] *fpr const char
* @param[in] *msg message
*
* @retval PEP_STATUS_OK
@ -3369,8 +3370,8 @@ static PEP_STATUS _get_detached_signature(message* msg,
*
* @brief TODO
*
* @param[in] *ptext constchar
* @param[in] psize constsize_t
* @param[in] *ptext const char
* @param[in] psize const size_t
* @param[out] **stext char
* @param[out] *ssize size_t
*
@ -4433,8 +4434,8 @@ static PEP_STATUS reconcile_src_and_inner_messages(message* src,
* @brief TODO
*
* @param[in] session session handle
* @param[in] *own_id constchar
* @param[in] *fpr constchar
* @param[in] *own_id const char
* @param[in] *fpr const char
*
* @retval bool
*/
@ -4471,7 +4472,7 @@ static bool is_trusted_own_priv_fpr(PEP_SESSION session,
* @brief TODO
*
* @param[in] session session handle
* @param[in] *fpr constchar
* @param[in] *fpr const char
*
* @retval bool
*/
@ -6717,8 +6718,8 @@ static char xor_hex_chars(char a, char b) {
*
* @brief TODO
*
* @param[in] *current constchar
* @param[in] *begin constchar
* @param[in] *current const char
* @param[in] *begin const char
*
*/
static const char* skip_separators(const char* current, const char* begin) {
@ -7053,13 +7054,12 @@ DYNAMIC_API PEP_STATUS get_message_trustwords(
*
* @brief TODO
*
* @param[in] *rating constchar
* @param[in] *rating const char
*
* @retval PEP_rating_undefined
* @retval PEP_rating_cannot_decrypt
* @retval PEP_rating_have_no_key
* @retval PEP_rating_unencrypted
* @retval PEP_rating_undefined
* @retval PEP_rating_unreliable
* @retval PEP_rating_reliable
* @retval PEP_rating_trusted
@ -7068,7 +7068,6 @@ DYNAMIC_API PEP_STATUS get_message_trustwords(
* @retval PEP_rating_mistrust
* @retval PEP_rating_b0rken
* @retval PEP_rating_under_attack
* @retval PEP_rating_undefined
*/
static PEP_rating string_to_rating(const char * rating)
{
@ -7108,7 +7107,7 @@ static PEP_rating string_to_rating(const char * rating)
*
* @brief TODO
*
* @param[in] *skeylist constchar
* @param[in] *skeylist const char
* @param[in] **keylist stringlist_t
*
* @retval PEP_STATUS_OK

@ -20,11 +20,11 @@ extern "C" {
*
* @brief TODO
*
* @param[in] session PEP_SESSION
* @param[in] msg message*
* @param[in] private_idents identity_list**
* @param[in] imported_keys stringlist_t**
* @param[in] changed_keys uint64_t*
* @param[in] session PEP_SESSION handle
* @param[in] msg message*
* @param[in] private_idents identity_list**
* @param[in] imported_key_list stringlist_t**
* @param[in] changed_keys uint64_t*
*
*/
bool import_attached_keys(
@ -32,7 +32,7 @@ bool import_attached_keys(
message *msg,
bool is_pEp_msg,
identity_list **private_idents,
stringlist_t** imported_keys,
stringlist_t** imported_key_list,
uint64_t* changed_keys,
char** imported_sender_key_fpr
);

@ -3604,22 +3604,7 @@ DYNAMIC_API PEP_STATUS get_revoked(
return status;
}
/**
* @internal
*
* <!-- get_replacement_fpr() -->
*
* @brief TODO
*
* @param[in] session session handle
* @param[in] *fpr const char
* @param[in] **revoked_fpr char
* @param[in] *revocation_date uint64_t
*
* @retval PEP_STATUS_OK
* @retval PEP_ILLEGAL_VALUE illegal parameter value
* @retval PEP_CANNOT_FIND_IDENTITY
* @retval PEP_OUT_OF_MEMORY out of memory
/* doxygen will fetch documentation from pEpEngine.h
*/
DYNAMIC_API PEP_STATUS get_replacement_fpr(
PEP_SESSION session,

@ -455,7 +455,7 @@ enum _expand_variable_state {
* See [FIXME: deployment-engineer documentation].
*
* @param[in] string_with_variables char *
* @param[out] copy_with_variables_expanded char **
* @param[out] out char** copy with variables expanded
* @retval PEP_STATUS_OK success
* @retval PEP_UNBOUND_ENVIRONMENT_VARIABLE unknown variable referenced
* @retval PEP_PATH_SYNTAX_ERROR invalid syntax in argument

@ -1,7 +1,7 @@
// This file is under GNU General Public License 3.0
// see LICENSE.txt
/// @file platform_windows.cpp
/// @brief Windows platform specification
/// @license This file is under GNU General Public License 3.0 - see LICENSE.txt
// Windows platform specification
#define WIN32_LEAN_AND_MEAN
#ifndef UNICODE

Loading…
Cancel
Save