Support @method static int foo() syntax for magic methods
#1855
Conversation
This file contains hidden or 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
Do this reading isStatic() from ReflectionDocBlock This was added to ReflectionDocBlock before the docblock 2.0.0 release, so it should be safe to assume that it's available (excluding beta versions) For issue phpDocumentor#822 This was tested locally with the following snippet: /** * @method static int fooStatic() implicitly a void */ class MyClass{}
Not sure how to indicate the first version where phpdocumentor supports it.
jaapio
requested changes
Jun 4, 2017
| @@ -377,6 +377,7 @@ public function testGetMagicMethods() | |||
| $methodMock->shouldReceive('getDescription')->andReturn($description); | |||
| $methodMock->shouldReceive('getResponse')->andReturn($response); | |||
| $methodMock->shouldReceive('getArguments')->andReturn($arguments); | |||
| $methodMock->shouldReceive('isStatic')->andReturn(true); | |||
There was a problem hiding this comment.
Please do add this to a new test. It is unclear to me now if the original behavior was not changed unintended.
It looks like is't ok, but I want to be sure.
| @@ -101,6 +101,7 @@ public function testMagicMethodsReturnsExpectedCollectionWithTags() | |||
| { | |||
| $mockMethodDescriptor = m::mock('phpDocumentor\Descriptor\Tag\MethodDescriptor'); | |||
| $mockMethodDescriptor->shouldReceive('getMethodName')->andReturn('Sample'); | |||
| $mockMethodDescriptor->shouldReceive('isStatic')->andReturn(false); | |||
There was a problem hiding this comment.
Same applies here, please add a new testcase.
|
Thanks for the quick response. |
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.
After this change, phpdoc API documentation generated from
@methodtags will indicate that the method is static the phpdoc tag was of the form@method static Type foo()Do this by reading isStatic() from ReflectionDocBlock
so it should be safe to assume that it's available (excluding beta versions of ReflectionDocBlock)
This was tested locally with the following snippet
(verified generated HTML API documentation was correct and static):
Add a draft of updating the docs for static method support.
For issue #822