-
Notifications
You must be signed in to change notification settings - Fork 0
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
charliekush
wants to merge
3
commits into
main
Choose a base branch
from
56-docs-single-line-fixes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 !#\$%&()*+-;<=>?@^_`{|}~. | ||
* @{ */ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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); | ||
} | ||
|
||
/** @ } */ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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