doxygen style comment for decompress #123
Closed
Conversation
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
Change-Id: Ie5ff9ebaffe3eff70e12fd52b608fc90468e650a
Change-Id: Ie061dff47a33fdc8995770c7a5f98129b8788556
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## Ie5ff9ebaffe3eff70e12fd52b608fc90468e650a #123 +/- ##
=============================================================================
- Coverage 82.22% 82.19% -0.03%
=============================================================================
Files 17 17
Lines 630 629 -1
Branches 38 37 -1
=============================================================================
- Hits 518 517 -1
+ Misses 96 94 -2
- Partials 16 18 +2 ☔ View full report in Codecov by Sentry. |
oliverlee
reviewed
Jan 6, 2024
| /// | ||
| /// @returns The decompressed bytes, or an error. | ||
| /// @tparam N The size of the compressed bytes. | ||
| /// @tparam ByteAllocator The allocator to use for the decompressed bytes. | ||
| template <std::size_t N, class ByteAllocator = std::allocator<std::byte>> | ||
| auto decompress( | ||
| std::span<const std::byte, N> compressed, ByteAllocator alloc = {}) |
There was a problem hiding this comment.
auto decompress(span<const byte, N> compressed, span<byte, M> dest)
-> decompress_result;
struct decompress_result
{
DecompressError status;
span remaining_compressed;
span remaining_dest;
};
oliverlee
force-pushed
the
Ie5ff9ebaffe3eff70e12fd52b608fc90468e650a
branch
from
d56844f
to
f2be076
Compare
Base automatically changed from
Ie5ff9ebaffe3eff70e12fd52b608fc90468e650a
to
master
January 6, 2024 18:46
|
Changed the interface and updated docs in another PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
doxygen style comment for decompress
Change-Id: Ie061dff47a33fdc8995770c7a5f98129b8788556