IBX-4929: Fixed PhpDoc in various places #226
Conversation
Tag "see" with body "@see \Ibexa\Contracts\Core\Repository\Values\Content\Relation::COMMON, \Ibexa\Contracts\Core\Repository\Values\Content\Relation::EMBED, \Ibexa\Contracts\Core\Repository\Values\Content\Relation::LINK, \Ibexa\Contracts\Core\Repository\Values\Content\Relation::FIELD" has error "\Ibexa\Contracts\Core\Repository\Values\Content\Relation::COMMON," is not a valid Fqsen.
Tag "param" with body "@param callable(\Ibexa\Contracts\Core\Repository\Repository): T $callback" has error "\Ibexa\Contracts\Core\Repository\:" is not a valid Fqsen.
Tag "since" with body "@SInCE eZ Platform 3.0" has error
Tag "since" with body "@SInCE eZ Platform 3.2" has error
Should have worked with inline @see tag according to https://docs.phpdoc.org/3.3/guide/references/phpdoc/tags/see.html#see but phpDocumentor may have difficulty with the inline version of @see phpDocumentor/phpDocumentor#1213 (comment)
Tag "see" with body "@see self::TYPE_*" has error "\Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator\self::TYPE_*" is not a valid Fqsen.
|
@ibexa/php-dev As @ViniTou in ibexa/http-cache#36 (comment) I would say that we could remove those |
|
There are several other |
alongosz
changed the title
| @@ -28,7 +28,7 @@ interface RoleService | |||
| /** | |||
| * Creates a new RoleDraft. | |||
| * | |||
| * @since 6.0 | |||
| * @since 1.0 eZ Platform 1.0 (ezpublish-kernel 6.0) | |||
There was a problem hiding this comment.
This should rather be just @since eZ Platform 1.0. Technically we can remove it, but I think it requires more discussion within PHP Team.
There was a problem hiding this comment.
@since eZ Platform 1.0 causes the log entry Tag "since" with body "@since eZ Platform 1.0" has error.
https://docs.phpdoc.org/3.3/guide/references/phpdoc/tags/since.html defines in @since [<version>] [<description>] the version number argument as optional, but, in fact, it is mandatory with phpDocumentor 3.3.1 which is looking for digit and dots only as first argument.
It's only a log, no element skipped, the tag even renders properly. It could be kept as @since eZ Platform 1.0 with no or minimal annoyance.
There was a problem hiding this comment.
I'm leaning towards dropping it entirely, at least for legacy Products. We can always infer that using git log. But I think we're planning internal sync with you about the entire PHP API Reference, aiming to discuss that as well.
|
Kudos, SonarCloud Quality Gate passed!
|
v4.5@sinceusage (Can I prefix eZ Publish era with0.?)@since eZ Platform 3.2@since 3.2 eZ Platform 3.2 (ezplatform-kernel 1.2)@since eZ Platform 3.0@since 3.0 eZ Platform 3.0 (ezplatform-kernel 1.0)@since v0.9.3(removed)@since 1.13 eZ Platform 1.13 (ezplatform-http-cache 0.9.3)@since 6.12@since 1.12 eZ Platform 1.12 (ezpublish-kernel 6.12)@since 6.0@since 1.0 eZ Platform 1.0 (ezpublish-kernel 6.0)@since 5.4.5@since 0.5.4.5 eZ Publish 5.4 (ezpublish-kernel 5.4)Fix
@seeusage:@seeand@linkdo not work in the summary line (the 1st line displayed in italic).Add
phpstan-prefix to advanced syntax out of standardChecklist:
$ composer fix-cs).@ibexa/engineering).