8000 docs: fixed some documentation errors in BLAKE2b by dsmurrow · Pull Request #1234 · TheAlgorithms/C · GitHub
[go: up one dir, main page]
Skip to content

docs: fixed some documentation errors in BLAKE2b #1234

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 16 commits into from
Apr 7, 2023
Merged

docs: fixed some documentation errors in BLAKE2b #1234

merged 16 commits into from
Apr 7, 2023

Conversation

dsmurrow
Copy link
Contributor
@dsmurrow dsmurrow commented Mar 19, 2023 •
edited
Loading

Description of Change

Removed doc comments describing include's as they seemed to mess up the doc generation. Also removed the define specifier in doc comments as Doxygen couldn't seem to parse them.

EDIT: I noticed a small bug in the algorithm which I fixed and added as a commit here
EDIT2: Added more tests for the algorithm

Checklist

  • Added description of change
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • I acknowledge that all my contributions will be made under the project's license.

dsmurrow added 2 commits March 19, 2023 04:16
@dsmurrow
docs: Slight modifications
7d21d97 
Changed #include comments from doc to regular because it messed up the generated documentation. Changed blake2b() comment from regular to doc
@dsmurrow
docs: Removed @define's
3429563 
Doxygen doesn't seem to like them. Also fixed param on CEIL
alexpantyukhin
alexpantyukhin previously approved these changes Mar 19, 2023
View reviewed changes
@Panquesito7 Panquesito7 added the enhancement New feature or request label Mar 24, 2023
Panquesito7
Panquesito7 reviewed Mar 24, 2023
View reviewed changes
@dsmurrow dsmurrow requested review from alexpantyukhin and Panquesito7 and removed request for alexpantyukhin and Panquesito7 March 24, 2023 23:42
Panquesito7
Panquesito7 requested changes Mar 31, 2023
View reviewed changes
@dsmurrow dsmurrow requested a review from Panquesito7 March 31, 2023 21:51
Panquesito7
Panquesito7 reviewed Apr 5, 2023
View reviewed changes
Panquesito7
Panquesito7 approved these changes Apr 5, 2023
View reviewed changes
Copy link
Member
@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

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

Thanks! 🚀

@Panquesito7 Panquesito7 merged commit 0c5eccc into TheAlgorithms:master Apr 7, 2023
@dsmurrow dsmurrow deleted the docs branch April 7, 2023 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexpantyukhin alexpantyukhin alexpantyukhin approved these changes

@Panquesito7 Panquesito7 Panquesito7 approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dsmurrow @alexpantyukhin @Panquesito7
0