From 23e16e6304382787f4373b0d62fd46ad6d0d3d25 Mon Sep 17 00:00:00 2001 From: Charlie Kushelevsky Date: Fri, 15 Nov 2024 08:27:26 -0800 Subject: [PATCH 1/3] chore: removed doc link to nonexistent file --- src/system.cpp | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/system.cpp b/src/system.cpp index 4044fdb4..9b9e2d49 100644 --- a/src/system.cpp +++ b/src/system.cpp @@ -220,11 +220,9 @@ static void SYS_waterTask(void) } } - - /** - * @brief Initialization function for GPS - * Ublox gps, handled by @file gps/location_service.cpp + * @brief Initialization function for GPS + * Ublox gps * @return int 1 on success, otherwise 0 */ static int SYS_initGPS(void) From cc2d68eb07dc598d0483d6447bf7baea2baadcdb Mon Sep 17 00:00:00 2001 From: Charlie Kushelevsky Date: Fri, 15 Nov 2024 08:31:56 -0800 Subject: [PATCH 2/3] chore: escaped special character for doxygen --- src/cellular/encoding/base85.h | 49 +++++++++++++++++----------------- 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/src/cellular/encoding/base85.h b/src/cellular/encoding/base85.h index cc780044..c6be6965 100644 --- a/src/cellular/encoding/base85.h +++ b/src/cellular/encoding/base85.h @@ -32,33 +32,34 @@ extern "C" { #include -/** @defgroup base85 Base85 Converter. - * Base85 RFC 1924 version. The character set is, in order, 0–9, A–Z, a–z, and - * then the 23 characters !#$%&()*+-;<=>?@^_`{|}~. - * @{ */ + /** @defgroup base85 Base85 Converter. + * Base85 RFC 1924 version. The character set is, in order, 0–9, A–Z, a–z, and + * then the 23 characters !#\$%&()*+-;<=>?@^_`{|}~. + * @{ */ -/** Convert a binary memory block in a base85 null-terminated string. - * If the size of the source memory block is not a multiple of four, - * as many zeros as necessary are added to convert it to a multiple of four. - * @param dest Destination memory where to put the base85 null-terminated string. - * @param src Source binary memory block. - * @param size Size in bytes of source binary memory block. - * @return A pointer to the null character of the base85 null-terminated string. */ -char* bintob85( char* dest, void const* src, size_t size ); + /** Convert a binary memory block in a base85 null-terminated string. + * If the size of the source memory block is not a multiple of four, + * as many zeros as necessary are added to convert it to a multiple of four. + * @param dest Destination memory where to put the base85 null-terminated string. + * @param src Source binary memory block. + * @param size Size in bytes of source binary memory block. + * @return A pointer to the null character of the base85 null-terminated string. */ + char *bintob85(char *dest, void const *src, size_t size); -/** Convert a base85 string to binary format. - * @param dest Destination memory block. - * @param src Source base85 string. - * @return If success a pointer to the next byte in memory block. - * Null if string has a bad format. */ -void* b85tobin( void* dest, char const* src ); + /** Convert a base85 string to binary format. + * @param dest Destination memory block. + * @param src Source base85 string. + * @return If success a pointer to the next byte in memory block. + * Null if string has a bad format. */ + void *b85tobin(void *dest, char const *src); -/** Convert a base85 string to binary format. - * @param p Source base85 string and destination memory block. - * @return If success a pointer to the next byte in memory block. - * Null if string has a bad format. */ -static inline void* b85decode( void* p ) { - return b85tobin( p, (char*)p ); + /** Convert a base85 string to binary format. + * @param p Source base85 string and destination memory block. + * @return If success a pointer to the next byte in memory block. + * Null if string has a bad format. */ + static inline void *b85decode(void *p) + { + return b85tobin(p, (char *)p); } /** @ } */ From 5f752728b94adfd2ddd248f3f39ec67567b6f748 Mon Sep 17 00:00:00 2001 From: Charlie Kushelevsky Date: Fri, 15 Nov 2024 08:32:39 -0800 Subject: [PATCH 3/3] chore: escaped special character for doxygen --- src/cellular/encoding/base85.h | 50 +++++++++++++++++----------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/src/cellular/encoding/base85.h b/src/cellular/encoding/base85.h index c6be6965..1fdb97e7 100644 --- a/src/cellular/encoding/base85.h +++ b/src/cellular/encoding/base85.h @@ -32,34 +32,34 @@ extern "C" { #include - /** @defgroup base85 Base85 Converter. - * Base85 RFC 1924 version. The character set is, in order, 0–9, A–Z, a–z, and - * then the 23 characters !#\$%&()*+-;<=>?@^_`{|}~. - * @{ */ +/** @defgroup base85 Base85 Converter. + * Base85 RFC 1924 version. The character set is, in order, 0–9, A–Z, a–z, and + * then the 23 characters !#\$%&()*+-;<=>?@^_`{|}~. + * @{ */ - /** Convert a binary memory block in a base85 null-terminated string. - * If the size of the source memory block is not a multiple of four, - * as many zeros as necessary are added to convert it to a multiple of four. - * @param dest Destination memory where to put the base85 null-terminated string. - * @param src Source binary memory block. - * @param size Size in bytes of source binary memory block. - * @return A pointer to the null character of the base85 null-terminated string. */ - char *bintob85(char *dest, void const *src, size_t size); +/** Convert a binary memory block in a base85 null-terminated string. + * If the size of the source memory block is not a multiple of four, + * as many zeros as necessary are added to convert it to a multiple of four. + * @param dest Destination memory where to put the base85 null-terminated string. + * @param src Source binary memory block. + * @param size Size in bytes of source binary memory block. + * @return A pointer to the null character of the base85 null-terminated string. */ +char *bintob85(char *dest, void const *src, size_t size); - /** Convert a base85 string to binary format. - * @param dest Destination memory block. - * @param src Source base85 string. - * @return If success a pointer to the next byte in memory block. - * Null if string has a bad format. */ - void *b85tobin(void *dest, char const *src); +/** Convert a base85 string to binary format. + * @param dest Destination memory block. + * @param src Source base85 string. + * @return If success a pointer to the next byte in memory block. + * Null if string has a bad format. */ +void *b85tobin(void *dest, char const *src); - /** Convert a base85 string to binary format. - * @param p Source base85 string and destination memory block. - * @return If success a pointer to the next byte in memory block. - * Null if string has a bad format. */ - static inline void *b85decode(void *p) - { - return b85tobin(p, (char *)p); +/** Convert a base85 string to binary format. + * @param p Source base85 string and destination memory block. + * @return If success a pointer to the next byte in memory block. + * Null if string has a bad format. */ +static inline void *b85decode(void *p) +{ + return b85tobin(p, (char *)p); } /** @ } */