Skip to content

Conversation

@Ashish-coder-gif
Copy link

Summary

This pull request adds Doxygen documentation comments for private functions in the entry.c file.

Changes Made

  • Added detailed Doxygen-style comments to private functions to improve code readability and maintainability.
  • Ensured consistent formatting across all new comments.
  • Verified that the documentation builds without errors using Doxygen.

Motivation

These updates address issue #371, which requested better documentation for private functions. Improved internal documentation will make it easier for contributors to understand and maintain the codebase.

Testing

  • Built the project successfully after adding comments.
  • Ran Doxygen to confirm all comments are properly recognized.

Related Issue

Fixes #371

@goatshriek goatshriek added the documentation documentation updates label Oct 19, 2025
@goatshriek
Copy link
Owner

As described in the issue, please cover a minimum of three functions, and include POSIX safety in each documentation block as done elsewhere in the project.

@goatshriek goatshriek marked this pull request as draft October 19, 2025 13:15
@Ashish-coder-gif Ashish-coder-gif marked this pull request as ready for review October 22, 2025 09:34
@goatshriek
Copy link
Owner

Checking in to see if you intend to continue this work, as described in the inactivity policy.

@goatshriek goatshriek added the stale inactive issue or pull request label Dec 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation documentation updates stale inactive issue or pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

document private functions

2 participants