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

Add PHP Doc to every public method of T-Regx API #17

Open
5 tasks
danon opened this issue Sep 26, 2018 · 2 comments
Open
5 tasks

Add PHP Doc to every public method of T-Regx API #17

danon opened this issue Sep 26, 2018 · 2 comments

Comments

@danon
Copy link
Member

danon commented Sep 26, 2018

  • Include a detailed documentation of every public method
  • Include only @param, @returns and @throws tags.
  • Include @psalm and @phpstan annotations
  • Include @see and @link attributes linking to classes and documentation on t-regx
  • Add @api tag to public elements and @internal tag to implementation details (most of Internal/ namespace)
@danon danon added this to To do in Release version Sep 16, 2019
@danon
Copy link
Member Author

danon commented Oct 17, 2019

This will be done with https://github.com/T-Regx/documentary

@danon danon moved this from To do to In progress in Release version Oct 20, 2019
@danon danon added the priority label Aug 13, 2020
@danon danon self-assigned this Nov 19, 2022
@danon
Copy link
Member Author

danon commented Nov 27, 2022

PhpDocumentor is wierd, for example it understands HTML both in summary and description; but only understands markdown in summary, and not in the description.

@danon danon pinned this issue Jan 4, 2023
@danon danon unpinned this issue Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Release version
  
In progress
Development

No branches or pull requests

1 participant