Skip to content
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.

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

[ENHANCEMENT]: generate documentation with phpdoc #1158

Open
2 tasks
jessevz opened this issue Dec 10, 2024 · 0 comments
Open
2 tasks

[ENHANCEMENT]: generate documentation with phpdoc #1158

jessevz opened this issue Dec 10, 2024 · 0 comments
Labels
enhancement Enhancement of existing features / Small addition server Hashtopolis API/Server related

Comments

@jessevz
Copy link
Contributor

jessevz commented Dec 10, 2024

Description

To generate documentation on a function level we can use phpdoc (https://docs.phpdoc.org/guide/getting-started/generating-documentation.html). This way we can automatically generate documentation based on the phpdoc comments.

  • Add phpdoc for relevant functions that don't have phpdoc yet
  • Automatically generate the documentation when code has been pushed
@jessevz jessevz added enhancement Enhancement of existing features / Small addition server Hashtopolis API/Server related labels Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement of existing features / Small addition server Hashtopolis API/Server related
Projects
None yet
Development

No branches or pull requests

1 participant