Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

56 docs single line fixes #136

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions src/cellular/encoding/base85.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,32 +33,33 @@ extern "C" {
#include <stddef.h>

/** @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 !#$%&()*+-;<=>?@^_`{|}~.
* @{ */
* Base85 RFC 1924 version. The character set is, in order, 0–9, A–Z, a–z, and
* then the 23 characters !#\$%&()*+-;<=>?@^_`{|}~.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please capture the characters in a code block group, e.g.:

`!#\$%&()*+-;<=>?@^_`{|}~.`

or something similar

* @{ */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally, close docstring group on its own line

/**
 *
 */


/** 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 );
* 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 );
* @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 );
* @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);
}

/** @ } */
Expand Down
6 changes: 2 additions & 4 deletions src/system.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading