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 missing PHPDoc comments for properties, constants, and more #109

Merged
merged 5 commits into from
Jul 7, 2021

Conversation

Xymph
Copy link
Collaborator

@Xymph Xymph commented Jul 7, 2021

Running PHPDoc (v2.9.1) highlighted that most class properties and constants were lacking comments, and existing ones were incomplete. Also, parameters to the Wikimate constructor method weren't documented, and the main file header was misformatted using /// comments.

@Xymph Xymph requested a review from waldyrious July 7, 2021 09:26
@Xymph Xymph force-pushed the 109-missing-phpdoc branch from 9ee893e to 5f89ebb Compare July 7, 2021 14:18
@Xymph Xymph force-pushed the 109-missing-phpdoc branch from 5f89ebb to daa6bc4 Compare July 7, 2021 14:20
@Xymph
Copy link
Collaborator Author

Xymph commented Jul 7, 2021

Reworked feedback in e7bc048. Btw, did you see my email on your gmail?

@waldyrious
Copy link
Collaborator

waldyrious commented Jul 7, 2021

Btw, did you see my email on your gmail?

I just did, and responded.

By the way, could you add this comment in the PR diff, rather than the stand-alone commit page? GitHub get a bit confused by comments added there, and they can't be marked as resolved. (If you do that, I'll copy my response as well, and then we can delete the comments from the commit page to clean things up.) (Update: done)

@Xymph
Copy link
Collaborator Author

Xymph commented Jul 7, 2021

By the way, could you add this comment in the PR diff, rather than the stand-alone commit page? GitHub get a bit confused by comments added there, and they can't be marked as resolved. (If you do that, I'll copy my response as well, and then we can delete the comments from the commit page to clean things up.)

Copied, and original comment removed. The constant itself is also gone.

Copy link
Collaborator

@waldyrious waldyrious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@waldyrious waldyrious merged commit e9b5d1c into hamstar:master Jul 7, 2021
@Xymph Xymph deleted the 109-missing-phpdoc branch July 7, 2021 15:48
@Xymph Xymph mentioned this pull request Aug 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants