Skip to content

Add docstrings and CI enforcement#26

Merged
ChrisNourse merged 1 commit intomainfrom
codex/check-function-descriptions-format
Jun 8, 2025
Merged

Add docstrings and CI enforcement#26
ChrisNourse merged 1 commit intomainfrom
codex/check-function-descriptions-format

Conversation

@ChrisNourse
Copy link
Owner

Summary

  • document all functions with Doxygen comments
  • add script to check for missing comments
  • run docstring check in GitHub Actions
  • rewrite doc_check script in portable C

Testing

  • make test
  • gcc -std=c99 -Wall -Wextra -o tools/doc_check tools/doc_check.c
  • tools/doc_check src/*.c src/*.h src/*.cpp

https://chatgpt.com/codex/tasks/task_e_6844c7a44328832394311cc8c623a168

@ChrisNourse ChrisNourse added the patch For bug fixes label Jun 8, 2025
@ChrisNourse ChrisNourse merged commit 3227b36 into main Jun 8, 2025
5 of 7 checks passed
@github-actions
Copy link

github-actions bot commented Jun 8, 2025

Version Bump Completed 🚀

Based on this PR's patch label, a new release version 1.4.4 has been created and tagged automatically.

The release workflow has been triggered to build and publish the release assets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex patch For bug fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant