Skip to content

Remove @internal annotation from PHPMock::getMockBuilder #13

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

Closed
sc0rp10 opened this issue Feb 3, 2017 · 4 comments
Closed

Remove @internal annotation from PHPMock::getMockBuilder #13

sc0rp10 opened this issue Feb 3, 2017 · 4 comments
Milestone

Comments

@sc0rp10
Copy link

sc0rp10 commented Feb 3, 2017

In my IDE (PhpStorm) this annotation mark method call as a problem.

Maybe is there reason for remove this for clear and helpful IDE messages?

@malkusch
Copy link
Member

malkusch commented Feb 17, 2017

I use the @internal annotation to mark

that the associated Structural Elements are used purely for the internal workings of this piece of software.

In particular to avoid apearing such internal details in the API documentation.

I actually don't need those abstract methods in the trait. I have them there for convenience, so that the code makes sense while calling those methods from the expected PHPUnit API.

But for you as a PHPUnit user they are part of the public API of PHPUnit. Actually I don't know what should be a correct behaviour for this case. I don't think it's well defined in PHPDoc and last time I checked, this FIG soap was about to implode or at least PSR-5 died. Ok, before I make any action on that, I need some authoritative information about the correct behaviour. I'll try to get that from https://github.com/phpDocumentor/phpDocumentor2.

@emirb
Copy link

emirb commented Feb 6, 2018

@malkusch Can you fully remove those abstract methods in the trait, as you said you don't need them actually? They add no value and just pollute inspections in PhpStorm.

@michalbundyra
Copy link
Member

@emirb Please see #27, methods from trait are there removed.

@michalbundyra michalbundyra added this to the 2.1.0 milestone Mar 22, 2018
@emirb
Copy link

emirb commented Mar 22, 2018

Thanks @webimpress!

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

No branches or pull requests

4 participants