eclipse/tinydtls
1
0
Fork 0
mirror of https://github.com/eclipse/tinydtls.git synced 2025-05-08 11:27:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: Correct Doxygen information

Browse Source 
Dynamically build DoxygenLayout.xml to get the latest layout for the current
version of doxygen.

Update Doxyfile.in to the Ubuntu20 version.

Signed-off-by: Jon Shallow <supjps-libcoap@jpshallow.com>
This commit is contained in:
Jon Shallow 2021-07-03 20:48:36 +01:00 committed by obgm
parent 0bd943fc3e
commit 1e1edc0da6
7 changed files with 1807 additions and 999 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ccm.h
View File

@ -33,7 +33,7 @@
* \param ctx The initialized rijndael_ctx object to be used for AES operations.
* \param M The number of authentication octets.
* \param L The number of bytes used to encode the message length.
* \param N The nonce value to use. You must provide \c DTLS_CCM_BLOCKSIZE
* \param nonce The nonce value to use. You must provide \c DTLS_CCM_BLOCKSIZE
* nonce octets, although only the first \c 16 - \p L - 1 are used.
* \param msg The message to encrypt. The first \p la octets are additional
* authentication data that will be cleartext. Note that the

32
crypto.h
View File

@ -205,11 +205,15 @@ typedef struct {
* \param h Identifier of the hash function to use.
* \param key The secret.
* \param keylen Length of \p key.
* \param seed The seed.
* \param seedlen Length of \p seed.
* \param label The label.
* \param labellen Length of \p label.
* \param random1 The random pt 1.
* \param random1len Length of \p random1.
* \param random2 The random pt 2.
* \param random2len Length of \p random2.
* \param buf Output buffer where the result is XORed into
* The buffe must be capable to hold at least
* \p buflen bytes.
* \param buflen The available space for \p buf
*
* \return The actual number of bytes written to \p buf or 0
* on error.
*/
@ -275,7 +279,10 @@ typedef struct {
* \param params AEAD parameters: Nonce, M and L.
* \param src The data to encrypt.
* \param length The actual size of of \p src.
* \param buf The result buffer.
* \param buf The result buffer. \p src and \p buf must not
* overlap.
* \param key The key to use
* \param keylen The length of the key
* \param aad additional data for AEAD ciphers
* \param aad_length actual size of @p aad
* \return The number of encrypted bytes on success, less than zero
@ -302,8 +309,11 @@ int dtls_encrypt_params(const dtls_ccm_params_t *params,
* \param buf The result buffer.
* \param nonce The nonce used for encryption. Must be exactly 13
* bytes, because L is set to 2.
* \param key The key to use
* \param keylen The length of the key
* \param aad additional data for AEAD ciphers
* \param aad_length actual size of @p aad
*
* \return The number of encrypted bytes on success, less than zero
* otherwise.
*
@ -325,11 +335,14 @@ int dtls_encrypt(const unsigned char *src, size_t length,
* block have been processed. The provided \p src and \p buf may overlap.
*
* \param params AEAD parameters: Nonce, M and L.
* \param src The buffer to decrypt.
* \param src The input buffer to decrypt.
* \param length The length of the input buffer.
* \param buf The result buffer.
* \param key The key to use
* \param keylen The length of the key
* \param aad additional authentication data for AEAD ciphers
* \param aad_length actual size of @p aad
*
* \return Less than zero on error, the number of decrypted bytes
* otherwise.
*/
@ -352,8 +365,10 @@ int dtls_decrypt_params(const dtls_ccm_params_t *params,
* \param buf The result buffer.
* \param nonce The nonce used for encryption. Must be exactly 13
* bytes, because L is set to 2.
* \param aad additional authentication data for AEAD ciphers
* \param aad_length actual size of @p aad
* \param key The key to use
* \param keylen The key to use
* \param a_data additional authentication data for AEAD ciphers
* \param a_data_length actual size of @p aad
* \return Less than zero on error, the number of decrypted bytes
* otherwise.
*
@ -376,6 +391,7 @@ int dtls_decrypt(const unsigned char *src, size_t length,
* @param key The shared key.
* @param keylen Length of @p key in bytes.
* @param result The derived pre master secret.
* @param result_len The length of derived pre master secret.
* @return The actual length of @p result.
*/
int dtls_psk_pre_master_secret(unsigned char *key, size_t keylen,

2571
doc/Doxyfile.in
View File

File diff suppressed because it is too large Load Diff

184
doc/DoxygenLayout.xml
View File

@ -1,184 +0,0 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="yes" title=""/>
<tab type="modules" visible="yes" title=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespaces" visible="yes" title=""/>
<tab type="namespacemembers" visible="yes" title=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classes" visible="yes" title=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title=""/>
<tab type="classmembers" visible="yes" title=""/>
</tab>
<tab type="files" visible="yes" title="">
<tab type="files" visible="yes" title=""/>
<tab type="globals" visible="yes" title=""/>
</tab>
<tab type="dirs" visible="yes" title=""/>
<tab type="examples" visible="yes" title=""/>
</navindex>
<!-- Layout definition for a class page -->
<class>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<allmemberslink visible="yes"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<protectedtypes title=""/>
<protectedslots title=""/>
<protectedmethods title=""/>
<protectedstaticmethods title=""/>
<protectedattributes title=""/>
<protectedstaticattributes title=""/>
<packagetypes title=""/>
<packagemethods title=""/>
<packagestaticmethods title=""/>
<packageattributes title=""/>
<packagestaticattributes title=""/>
<properties title=""/>
<events title=""/>
<privatetypes title=""/>
<privateslots title=""/>
<privatemethods title=""/>
<privatestaticmethods title=""/>
<privateattributes title=""/>
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<constructors title=""/>
<functions title=""/>
<related title=""/>
<variables title=""/>
<properties title=""/>
<events title=""/>
</memberdef>
<usedfiles visible="$SHOW_USED_FILES"/>
<authorsection visible="yes"/>
</class>
<!-- Layout definition for a namespace page -->
<namespace>
<briefdescription visible="yes"/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection visible="yes"/>
</namespace>
<!-- Layout definition for a file page -->
<file>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<includegraph visible="$INCLUDE_GRAPH"/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection/>
</file>
<!-- Layout definition for a group page -->
<group>
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<dirs visible="yes" title=""/>
<nestedgroups visible="yes" title=""/>
<files visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
</memberdef>
<authorsection visible="yes"/>
</group>
<!-- Layout definition for a directory page -->
<directory>
<briefdescription visible="yes"/>
<directorygraph visible="yes"/>
<memberdecl>
<dirs visible="yes"/>
<files visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
</directory>
</doxygenlayout>

3
doc/Makefile.in
View File

@ -18,7 +18,8 @@ DISTDIR?=$(top_builddir)/@PACKAGE_TARNAME@-@PACKAGE_VERSION@
FILES:=Makefile.in Doxyfile.in html
doc: Doxyfile
$(DOXYGEN) $< >./doxygen.out 2>&1
$(DOXYGEN) -l
$(DOXYGEN) $< >./doxygen.out
clean:
@rm -rf html

6
dtls.c
View File

@ -1727,8 +1727,9 @@ static unsigned char sendbuf[DTLS_MAX_BUF];
* @param security The encryption paramater used to encrypt.
* @param session The transport address of the remote peer.
* @param type The content type of this record.
* @param buf The data to send.
* @param buflen The number of bytes to send from @p buf.
* @param buf_array The array of data to send.
* @param buf_len_array The number of bytes in each array element.
* @param buf_array_len The number of array elements.
* @return Less than zero in case of an error or the number of
* bytes that have been sent otherwise.
*/
@ -1926,6 +1927,7 @@ dtls_destroy_peer(dtls_context_t *ctx, dtls_peer_t *peer, int flags) {
* \param ephemeral_peer The remote party we are talking to, if any.
* \param data The received datagram.
* \param data_length Length of \p msg.
*
* \return \c 0 if msg is a ClientHello with a valid cookie, \c 1 or
* \c -1 otherwise.
*/

8
dtls_prng.h
View File

@ -17,7 +17,7 @@
*******************************************************************************/
/**
* @file prng.h
* @file dtls_prng.h
* @brief Pseudo Random Numbers
*/
@ -37,8 +37,8 @@
* implementation for prng(). You might want to change prng() to use
* a better PRNG on your specific platform.
*
* @buf The buffer to fill
* @len the length of the buffer to fill
* @param buf The buffer to fill
* @param len the length of the buffer to fill
*
* @return 1 buffer filled
*/
@ -47,7 +47,7 @@ int dtls_prng(unsigned char *buf, size_t len);
/**
* Seeds the random number generator used by the function dtls_prng()
*
* @seed The seed to prime the random number generator
* @param seed The seed to prime the random number generator
*/
void dtls_prng_init(unsigned seed);