ADD README.md and docblock #8
Merged
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
I add README.md file and docblocks for classes.
Dylan-DPC-zz
requested changes
Oct 11, 2017
|
|
||
| /** | ||
| * Class HashFailedException | ||
| * @package Dpc\HashVerifier\Exceptions |
There was a problem hiding this comment.
this isn't needed. It is understood from the namespace
README.md
Outdated
|
|
||
| ## History | ||
|
|
||
| TODO: Write history |
README.md
Outdated
|
|
||
| ## Usage | ||
|
|
||
| TODO: Write usage instructions |
There was a problem hiding this comment.
can you attempt this based on the example I have given? If not I will add it later
.idea/modules.xml
Outdated
| @@ -4,6 +4,7 @@ | |||
| <modules> | |||
| <module fileurl="file://$PROJECT_DIR$/.idea/Authvalidator.iml" filepath="$PROJECT_DIR$/.idea/Authvalidator.iml" /> | |||
| <module fileurl="file://$PROJECT_DIR$/.idea/hash-verifier.iml" filepath="$PROJECT_DIR$/.idea/hash-verifier.iml" /> | |||
| <module fileurl="file://$PROJECT_DIR$/.idea/hash-verifier.iml" filepath="$PROJECT_DIR$/.idea/hash-verifier.iml" /> | |||
There was a problem hiding this comment.
can you remove this folder from tracking? had added it by mistake
MayMeow
changed the title
|
Yes because you have tracked /.idea/* folder ... ;) |
|
.. and my docblcks :D |
Add more explanations
MayMeow
changed the title
Dylan-DPC-zz
approved these changes
Oct 13, 2017
Closed
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.
I add README.md file and docblocks for classes.