PHPDoc improvements and type hinting of variables. #557
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Here some suggestions for improving the PHPDoc in the `OAuth2\Controller\TokenController.php`. Currently in my php code editor it was a bit messy. Proper PHPDoc and variable declaration can really help understanding the working of this OAuth2 module. Right now I only change this controller, but if you merge this pull request I am very willing to also spend time updating/improving the PHPDoc of any other files in the repo.
|
Hey, this looks great! Which code editor are you using? |
|
Hello Brent, |
|
@Wilt I would love to see this standard for documenting implemented as standard across the library |
added 8 commits
October 8, 2015 15:25
Conflicts: src/OAuth2/Controller/TokenController.php src/OAuth2/Encryption/Jwt.php src/OAuth2/Server.php src/OAuth2/Storage/Pdo.php
+ changed getQuerystringIdentifier to getQueryStringIdentifier
|
@bshaffer I finally found some time to work myself through the library and add php-docs and type hinting as in the example. I tried to be as thorough as possible and I think it is a good start. I believe it will also motivate other contributors to improve/update the php-doc even more. I did not manage to add docs to all Storage classes yet, but this can be added later. Hope you like it. |
Merged
|
merged! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here some suggestions for improving the PHPDoc in the
OAuth2\Controller\TokenController.php.Currently in my php code editor it looked all a bit messy. Proper PHPDoc and variable declaration can really help understanding the working of this OAuth2 module.
Right now I only change this controller, but if you merge this pull request I am very willing to also spend time updating/improving the PHPDoc of any other files in the repo.