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

Invalid inline documentation #619

Closed
martijnmelchers opened this issue May 20, 2018 · 4 comments · Fixed by #620
Closed

Invalid inline documentation #619

martijnmelchers opened this issue May 20, 2018 · 4 comments · Fixed by #620
Labels
difficulty: easy fix is easy in difficulty status: help wanted requesting help from the community type: docs update documentation change not affecting the code

Comments

@martijnmelchers
Copy link
Contributor

Hi, nice work on the inline commenting although some mistakes have been made! Easily fixable and will probably send a pull-request to fix it soon.

The variables you comments with // but those also have to be done with /**/ or PHPDoc won't accept them.

Shown below:

1c320eb43040ce81a01c0e2d7 1

@thinkingserious thinkingserious added status: help wanted requesting help from the community difficulty: easy fix is easy in difficulty up-for-grabs type: docs update documentation change not affecting the code labels May 22, 2018
@thinkingserious
Copy link
Contributor

Thanks @martijnmelchers!

What tool are you using to catch those errors? phpcs did not catch those :(

With Best Regards,

Elmer

@martijnmelchers
Copy link
Contributor Author

My editor is IntellIJ but the docs also state that they need to start with /**

You can read that here

@thinkingserious
Copy link
Contributor

Thanks @martijnmelchers!

Not sure why the linter is not catching it, but it definitely is wrong. I'll leave this issue open until we can resolve it.

@martijnmelchers
Copy link
Contributor Author

I will resolve it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy fix is easy in difficulty status: help wanted requesting help from the community type: docs update documentation change not affecting the code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants