From 10f4ffa05a84085d6b2cf415b42b8056591a3529 Mon Sep 17 00:00:00 2001 From: TLINDEN Date: Sun, 11 Jan 2015 13:14:02 +0100 Subject: [PATCH] fixed doxygen errors --- include/pcp/buffer.h | 5 ++--- include/pcp/context.h | 10 +++++----- include/pcp/crypto.h | 14 ++++++++------ include/pcp/ed.h | 12 ++++++------ include/pcp/key.h | 14 ++++++-------- include/pcp/keyhash.h | 14 +++++++------- include/pcp/vault.h | 12 ++++++------ include/pcp/z85.h | 8 ++++---- man/.doxygen | 2 +- 9 files changed, 45 insertions(+), 46 deletions(-) diff --git a/include/pcp/buffer.h b/include/pcp/buffer.h index bd58ae9..38f870e 100644 --- a/include/pcp/buffer.h +++ b/include/pcp/buffer.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013-2014 T.v.Dein. + Copyright (C) 2013-2015 T.v.Dein. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -280,8 +280,7 @@ int buffer_done(Buffer *b); be 0 in case of errors. See also: fatals_ifany(), buffer_done() and buffer_left(). \param[in] b The Buffer object to read from. - \param[out] buf The destination pointer where the data will be copied to. This pointer -must be allocated by the caller properly and it must have at least a size of len. + \param[out] buf The destination pointer where the data will be copied to. This pointer must be allocated by the caller properly and it must have at least a size of len. \param[in] len The number of bytes to read from the Buffer. \return Returns the size of bytes read, 0 in case an error occurred. */ diff --git a/include/pcp/context.h b/include/pcp/context.h index ec903ca..1f01d25 100644 --- a/include/pcp/context.h +++ b/include/pcp/context.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013-2014 T.v.Dein. + Copyright (C) 2013-2015 T.v.Dein. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -51,7 +51,7 @@ PCPCTX *ptx_new(); /** Frees the memory allocated by the context. - \param[in] PCP Context object. + \param[in] ptx PCP Context object. */ void ptx_clean(PCPCTX *ptx); @@ -62,7 +62,7 @@ void ptx_clean(PCPCTX *ptx); which it stores in the global PCP_ERR variable and sets PCP_ERRSET to 1. - \param[in] PCP Context object. + \param[in] ptx PCP Context object. \param[in] fmt printf() like format description. @@ -75,7 +75,7 @@ void fatal(PCPCTX *ptx, const char * fmt, ...); FIXME: add something like this which returns the message. - \param[in] PCP Context object. + \param[in] ptx PCP Context object. */ void fatals_ifany(PCPCTX *ptx); @@ -84,7 +84,7 @@ void fatals_ifany(PCPCTX *ptx); This can be used to ignore previous errors. Use with care. - \param[in] PCP Context object. + \param[in] ptx PCP Context object. */ void fatals_reset(PCPCTX *ptx); diff --git a/include/pcp/crypto.h b/include/pcp/crypto.h index 3ab2575..fc3d680 100644 --- a/include/pcp/crypto.h +++ b/include/pcp/crypto.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013 T.Linden. + Copyright (C) 2013-2015 T.Linden. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -134,6 +134,8 @@ int pcp_sodium_verify_box(byte **cleartext, byte* message, requirement to work with raw NaCL crypto_box() output. This function adds the neccessary padding and it uses PCP key structures. + \param[in] ptx pcp context. + \param[in] secret The secret key structure from the sender. \param[in] pub The public key structure from the recipient. @@ -158,7 +160,7 @@ byte *pcp_box_encrypt(PCPCTX *ptx, pcp_key_t *secret, pcp_pubkey_t *pub, requirement to work with raw NaCL crypto_box() output. This function adds the neccessary padding and it uses PCP key structures. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] secret The secret key structure from the sender. @@ -185,7 +187,7 @@ byte *pcp_box_decrypt(PCPCTX *ptx, pcp_key_t *secret, pcp_pubkey_t *pub, Calls pcp_encrypt_stream_sym() after assembling the encrypted recipient list. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] in Stream to read the data to encrypt from. @@ -211,7 +213,7 @@ size_t pcp_encrypt_stream(PCPCTX *ptx, Pcpstream *in, Pcpstream* out, pcp_key_t Uses crypto_secret_box() for each 32k-block with a random nonce for each. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] in Stream to read the data to encrypt from. @@ -238,7 +240,7 @@ size_t pcp_encrypt_stream_sym(PCPCTX *ptx, Pcpstream *in, Pcpstream* out, byte * FIXME: should return the pcp_rec_t structure upon successfull verification somehow. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] in Stream to read the data to decrypt from. @@ -266,7 +268,7 @@ size_t pcp_decrypt_stream(PCPCTX *ptx, Pcpstream *in, Pcpstream* out, pcp_key_t Uses crypto_secret_box_open() for each 32k+16-block with a random nonce for each. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] in Stream to read the data to decrypt from. diff --git a/include/pcp/ed.h b/include/pcp/ed.h index 0221912..316078e 100644 --- a/include/pcp/ed.h +++ b/include/pcp/ed.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013-2014 T.v.Dein. + Copyright (C) 2013-2015 T.v.Dein. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -81,7 +81,7 @@ byte *pcp_ed_sign(byte *message, size_t messagesize, pcp_key_t *s); The signature must contain the message+nacl signature (with size crypto_sign_BYTES). - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] signature Message+signature. @@ -100,7 +100,7 @@ byte *pcp_ed_verify(PCPCTX *ptx, byte *signature, size_t siglen, pcp_pubkey_t *p The signature must contain the message+nacl signature (with size crypto_sign_BYTES). - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] signature Message+signature. @@ -119,7 +119,7 @@ byte *pcp_ed_verify_key(PCPCTX *ptx, byte *signature, size_t siglen, pcp_pubkey_ of the contents of the stream. It outputs the stream to \a out, also blockwise and appends the signature afterwards, which consists of the hash+nacl-signature. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] in Stream to read from. @@ -147,7 +147,7 @@ size_t pcp_ed_sign_buffered(PCPCTX *ptx, Pcpstream *in, Pcpstream *out, pcp_key_ the global public key hash pcppubkey_hash to find a public key which is able to verify the signature. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] in Stream to read from. @@ -183,7 +183,7 @@ size_t pcp_ed_detachsign_buffered(Pcpstream *in, Pcpstream *out, pcp_key_t *s); the signature hash with the hash it calculated from the signed content. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] in Stream to read from. diff --git a/include/pcp/key.h b/include/pcp/key.h index 2e958fb..550e8a0 100644 --- a/include/pcp/key.h +++ b/include/pcp/key.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013-2014 T.v.Dein. + Copyright (C) 2013-2015 T.v.Dein. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -134,7 +134,7 @@ char *pcpkey_get_art(pcp_key_t *k); The caller is responsible to clear the passphrase right after use and free() it as soon as possible. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in,out] key The secret key structure. @@ -160,7 +160,7 @@ pcp_key_t *pcpkey_encrypt(PCPCTX *ptx, pcp_key_t *key, char *passphrase); The caller is responsible to clear the passphrase right after use and free() it as soon as possible. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in,out] key The secret key structure. @@ -179,8 +179,6 @@ pcp_key_t *pcpkey_decrypt(PCPCTX *ptx, pcp_key_t *key, char *passphrase); The caller is responsible to clear and free() it after use. - \param[in] pcp context. - \param[in] key The secret key structure. \return Returns a new pcp_pubkey_t structure. @@ -272,6 +270,8 @@ Buffer *pcp_keyblob(void *k, int type); /* allocates blob */ /** Make a sanity check of the given public key structure. + \param[in] ptx pcp context. + \param[in] key The public key structure. \return Returns 1 if the sanity check succeeds, 0 otherwise. @@ -281,7 +281,7 @@ int pcp_sanitycheck_pub(PCPCTX *ptx, pcp_pubkey_t *key); /** Make a sanity check of the given secret key structure. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] key The secret key structure. @@ -292,8 +292,6 @@ int pcp_sanitycheck_key(PCPCTX *ptx, pcp_key_t *key); /** Dump a secret key structure to stderr. - \param[in] pcp context. - \param[in] k Secret key to dump. */ void pcp_dumpkey(pcp_key_t *k); diff --git a/include/pcp/keyhash.h b/include/pcp/keyhash.h index 03a2aab..53097ef 100644 --- a/include/pcp/keyhash.h +++ b/include/pcp/keyhash.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013 T.Linden. + Copyright (C) 2013-2015 T.Linden. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -79,7 +79,7 @@ /** Delete an entry from a hash. - \param[in] PCP Context object. + \param[in] ptx Pcp Context object. \param[in] key A pointer to the key structure to delete. @@ -96,7 +96,7 @@ void pcphash_cleanpub(pcp_pubkey_t *pub); /** Check if a secret key with a given key-id exists in the hash. - \param[in] PCP Context object. + \param[in] ptx Pcp Context object. \param[in] id A string with the key-id (max 17 chars incl 0). @@ -106,7 +106,7 @@ pcp_key_t *pcphash_keyexists(PCPCTX *ptx, char *id); /** Check if a publickey with a given key-id exists in the hash. - \param[in] PCP Context object. + \param[in] ptx Pcp Context object. \param[in] id A string with the key-id (max 17 chars incl 0). @@ -116,7 +116,7 @@ pcp_pubkey_t *pcphash_pubkeyexists(PCPCTX *ptx, char *id); /** Add a key structure to the hash list. - \param[in] PCP Context object. + \param[in] ptx Pcp Context object. \param[in] key A pointer to the key structure to delete. @@ -126,7 +126,7 @@ void pcphash_add(PCPCTX *ptx, void *key, int type); /** Returns the number of secret keys in the hash. - \param[in] PCP Context object. + \param[in] ptx Pcp Context object. \return Number of keys. */ @@ -134,7 +134,7 @@ int pcphash_count(PCPCTX *ptx); /** Returns the number of public keys in the hash. - \param[in] PCP Context object. + \param[in] ptx Pcp Context object. \return Number of keys. */ diff --git a/include/pcp/vault.h b/include/pcp/vault.h index e213047..4abdede 100644 --- a/include/pcp/vault.h +++ b/include/pcp/vault.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013-2014 T.v.Dein. + Copyright (C) 2013-2015 T.v.Dein. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -96,7 +96,7 @@ /** Open a vault file. If the file doesn't exist, it will be created. - \param[in] pcp context. + \param[in] ptx pcp context. \param[in] filename The filename of the vault file. \return Returns a vault object. @@ -124,7 +124,7 @@ int pcpvault_create(PCPCTX *ptx, vault_t *vault); This function writes directly into the vault file. Use with care. To be safe, use pcpvault_addkey() instead. - \param[in] pcp context. + \param[in] ptx pcp context. \param[out] vault The vault object. \param[in] item The item to write. \param[in] itemsize Size of the item. @@ -148,7 +148,7 @@ int pcpvault_additem(PCPCTX *ptx, vault_t *vault, void *item, size_t itemsize, u back to the original location. It then re-calculates the vault checksum and puts it into the vault header. - \param[in] pcp context. + \param[in] ptx pcp context. \param[out] vault The vault object. \param[in] item The item to write (a key or keysig) \param[in] type Type of the item. \see _PCP_KEY_TYPES. @@ -167,7 +167,7 @@ int pcpvault_addkey(PCPCTX *ptx, vault_t *vault, void *item, uint8_t type); contain the filename of the backup file, so that the user doesn't loose data. - \param[in] pcp context. + \param[in] ptx pcp context. \param[out] vault The vault object. \return Returns 0. Check fatals_if_any() anyway. @@ -195,7 +195,7 @@ void pcpvault_free(vault_t *vault); contents and compares it with the one stored in the vault header. If it doesn't match an error will be thrown. - \param[in] pcp context. + \param[in] ptx pcp context. \param[out] vault The vault object. \return Returns 0 on success or -1 in case of errors. Check fatals_if_any(). diff --git a/include/pcp/z85.h b/include/pcp/z85.h index 385e72c..0ce0a30 100644 --- a/include/pcp/z85.h +++ b/include/pcp/z85.h @@ -1,7 +1,7 @@ /* This file is part of Pretty Curved Privacy (pcp1). - Copyright (C) 2013-2014 T.v.Dein. + Copyright (C) 2013-2015 T.v.Dein. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -78,7 +78,7 @@ size_t pcp_unpadfour(byte *src, size_t srclen); The input \a z85block may contain newlines which will be removed. - \param[in] the pcp context object. + \param[in] ptx pcp context object. \param[in] z85block The Z85 encoded string. \param[in] dstlen Returned size of decoded data (pointer to int). @@ -109,7 +109,7 @@ char *pcp_z85_encode(byte *raw, size_t srclen, size_t *dstlen, int doblock); Reads a file and returns the raw Z85 encoded string. It ignores newlines, comments and Headerstrings. - \param[in] the pcp context object. + \param[in] ptx pcp context object. \param[in] infile FILE stream to read from. \return Raw Z85 encoded string with comments, headers and newlines removed. @@ -121,7 +121,7 @@ char *pcp_readz85file(PCPCTX *ptx, FILE *infile); Parses the given input string and returns the raw Z85 encoded string. It ignores newlines, comments and Headerstrings. - \param[in] the pcp context object. + \param[in] ptx pcp context object. \param[in] input Z85 encoded string. \param[in] bufsize Size of the string. diff --git a/man/.doxygen b/man/.doxygen index eb28a82..86517cf 100644 --- a/man/.doxygen +++ b/man/.doxygen @@ -22,7 +22,7 @@ PROJECT_NAME = libpcp # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 0.2.1 +PROJECT_NUMBER = 0.2.4 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put.