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.

Sign up for GitHub

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

Jump to bottom

TODO: code documentation #1

Closed
YiiRocks opened this issue Jun 19, 2019 · 1 comment
Closed

TODO: code documentation #1

YiiRocks opened this issue Jun 19, 2019 · 1 comment
Labels
bug in external tool Something isn't working, but external tool needs to be fixed documentation Improvements or additions to documentation

Comments

@YiiRocks
Copy link
Collaborator

YiiRocks commented Jun 19, 2019 •
edited
Loading

Deal breaking bugs

PHP-Files/Classes are missing - severely impacting the value of the documentation export
Incorrect output when typehinting a variable as string - makes output confusing

Would be nice at a later stage

Add support for @method tags

Documentation itself is mostly done.
docs/* will be deleted, once an export (either md-files or HTML (preferred)) can be exported without issues.

See https://fai.mr42.me/ for current status.
@YiiRocks YiiRocks pinned this issue Jun 24, 2019
@YiiRocks YiiRocks added the documentation Improvements or additions to documentation label Jun 24, 2019
@YiiRocks YiiRocks self-assigned this Jun 24, 2019
@YiiRocks YiiRocks added bug Something isn't working bug in external tool Something isn't working, but external tool needs to be fixed and removed bug Something isn't working labels Jun 28, 2019
@YiiRocks YiiRocks changed the title TODO: proper code documentation TODO: code documentation Jul 7, 2019
@YiiRocks YiiRocks unpinned this issue Jul 7, 2019
@YiiRocks YiiRocks removed their assignment Jul 22, 2020
@Mister-42
Copy link
Contributor

Documention is on https://www.yii.rocks/yii2-fontawesome-inline/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug in external tool Something isn't working, but external tool needs to be fixed documentation Improvements or additions to documentation
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Mister-42