Enhance PHPDoc

[adriendupuis]

🎫 Issue	IBX-XXXXX

Description:

• Add missing summaries (discovered during Enhance PHP API REF metadata documentation-developer#2575). A summary is the first line of a docblock. It can't have advanced formatting as it won't be rendered.
• Type array keys to avoid generic array<string|int, rendering.
• Use triple-backticks to have code blocks instead of <code> rendered as a single line.
• TODO: Use class name instead of self to have a link (to the current page, debatable, it could also be $this).
• Reword some descriptions.

Previews:

• Ibexa\Contracts\Core\FieldType\Generic\ValidationError\ConstraintViolationAdapter
  • Before has not rendered @see tags in its introduction and <meta name="description".
  • TODO: [After]
• Ibexa\Contracts\Core\Limitation\Target\Builder\VersionBuilder
  • Before has not rendered @see tags in its introduction.
  • TODO: [After]
• Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion::getSpecifications()
  • Before, misses links to properties and constants, and has an example rendered as a single line.
  • TODO: [After] has links and and a proper code block.
• Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\DateMetadata
  • Before has an example rendered as a single line.
  • TODO: [After] has well rendered example and a link from DateMetadata::TRASHED to TrashService::findTrashItems()
• Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\UserMetadata
  • Before has two one-line examples, a typo in a quoted constant, a lack of links.
  • TODO: [After]
• Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator\Specifications
  • Before
  • TODO: [After]: description is reworded and a link to Criterion::getSpecifications() is added.
• Ibexa\Contracts\Core\Search\Capable
  • Before had a not rendered @see in its summary.
  • TODO: [After] had a new summary, and the link is in its description.

For QA:

Documentation:

[adriendupuis]

I didn't find such property in the contracts namespace. (I may haven't look well enough in the namespace.) It might not be in this contracts namespace, and hidden by abstraction. If no link can be made to it, it probably don't worth being mentioned.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud