Fix HasToString description #93
Conversation
aik099
left a comment
aik099
left a comment
There was a problem hiding this comment.
This note applies to all PRs.
Please also use the php generator/run.php to regenerate auto-generated files so they could be included in PR.
P.S.
I've created #37 for updating contributor instructions to include that command at least.
|
|
||
| /** | ||
| * Does array size satisfy a given matcher? | ||
| * Creates a matcher that matches any examined object whose toString method returns a value equalTo the specified string. |
There was a problem hiding this comment.
Please use text from the relevant java file to preserve formatting.
In this case only the <code>...</code> text was lost, but I'm not sure if PhpDoc supports it at all.
|
|
||
| /** | ||
| * Matches if array size satisfies a nested matcher. | ||
| * Matches an examined object whose toString method returns a value that satisfies the specified matcher. |
There was a problem hiding this comment.
Please use text from the relevant java file to preserve formatting.
The above-proposed text doesn't the matching Java file text.
P.S.
The previous text looks like a copy/paste from the https://github.com/hamcrest/JavaHamcrest/blob/master/hamcrest/src/main/java/org/hamcrest/collection/IsArrayWithSize.java file.
pscheit
force-pushed
the
fix-has-to-string-description
branch
from
72b4c99 to
d4a1be8
Compare
|
Have you checked that using |
|
Which software is used to render this as html? |
I have no idea. The https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.example.pkg.html page says that is correct syntax. |
|
:) yeah, unless its really rendered and looks odd, I wouldn't care too much about it. DocBlocks are like markdown, a defactor standard but it's all pretty wild. Guess this is entirely different for java. Since I don't see the generated api docs on the page, I wouldn't sweat it. This wrong docblock was probably there for ages :) |
2 participants
seems to have been copied from another class
took description from: https://hamcrest.org/JavaHamcrest/javadoc/1.3/org/hamcrest/object/HasToString.html#:~:text=.String%3E%20toStringMatcher)-,Creates%20a%20matcher%20that%20matches%20any%20examined%20object%20whose%20toString,that%20satisfies%20the%20specified%20matcher.