[PR #1234] [MERGED] docs: fixed some documentation errors in BLAKE2b #1826

Open
opened 2026-01-29 15:25:03 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/TheAlgorithms/C/pull/1234
Author: @dsmurrow
Created: 3/19/2023
Status: Merged
Merged: 4/7/2023
Merged by: @Panquesito7

Base: masterHead: docs


📝 Commits (10+)

📊 Changes

1 file changed (+87 additions, -16 deletions)

View changed files

📝 hash/hash_blake2b.c (+87 -16)

📄 Description

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.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/TheAlgorithms/C/pull/1234 **Author:** [@dsmurrow](https://github.com/dsmurrow) **Created:** 3/19/2023 **Status:** ✅ Merged **Merged:** 4/7/2023 **Merged by:** [@Panquesito7](https://github.com/Panquesito7) **Base:** `master` ← **Head:** `docs` --- ### 📝 Commits (10+) - [`7d21d97`](https://github.com/TheAlgorithms/C/commit/7d21d973ac2f36f5b30fc2f719cd4e9c5545afee) docs: Slight modifications - [`3429563`](https://github.com/TheAlgorithms/C/commit/3429563d0addb8a44fab9941dcc41aca62494a74) docs: Removed @define's - [`01072cc`](https://github.com/TheAlgorithms/C/commit/01072cc17e3fc0d7feae69d4ac784a2c56225e7b) chore: made it so math directory gets built - [`dd291a4`](https://github.com/TheAlgorithms/C/commit/dd291a49f3064f6be8c2163cf969a7108860e685) docs: added back third slash for includes - [`75d22fb`](https://github.com/TheAlgorithms/C/commit/75d22fb9ee8265559a25b82b86262b7a64057686) Merge branch 'master' into docs - [`3eff6c3`](https://github.com/TheAlgorithms/C/commit/3eff6c3b5653d9c1db316a133f3dd4d38dfdc59a) Merge branch 'master' into euclid - [`805b344`](https://github.com/TheAlgorithms/C/commit/805b3447a8a0e2b99046c7ab54fa196f1acecc53) feat: added extended Euclidean algorithm - [`643c85b`](https://github.com/TheAlgorithms/C/commit/643c85b9340dd074db52f53984d82f9b7f90aac9) Merge branch 'docs' of https://github.com/dsmurrow/TheAlgorithms_C into docs - [`cdd1cc9`](https://github.com/TheAlgorithms/C/commit/cdd1cc97e865e3c50e09b35141536b162b87ee64) fix: key wasn't being considered in the algorithm - [`07b32bc`](https://github.com/TheAlgorithms/C/commit/07b32bc8151c0fb6e0ab8a8f7458875d60bf5a6a) chore: added more tests ### 📊 Changes **1 file changed** (+87 additions, -16 deletions) <details> <summary>View changed files</summary> 📝 `hash/hash_blake2b.c` (+87 -16) </details> ### 📄 Description #### 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 <!-- Thank you for your Pull Request. Please provide a description above and review the requirements below. Contributors guide: https://github.com/TheAlgorithms/C/blob/master/CONTRIBUTING.md --> #### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [x] Added description of change - [x] Relevant documentation/comments is changed or added - [x] PR title follows semantic [commit guidelines](https://github.com/TheAlgorithms/C/blob/master/CONTRIBUTING.md#Commit-Guidelines) - [x] I acknowledge that all my contributions will be made under the project's license. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 15:25:03 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/C#1826