Skip to content

[TASK] Add SchemaGenerator evaluation for "@see" #1047

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.

Sign up for GitHub

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

Merged
lolli42 merged 1 commit into from
Apr 9, 2025
Merged

[TASK] Add SchemaGenerator evaluation for "@see" #1047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Schema/SchemaGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ public function generate(string $xmlNamespace, array $viewHelpers): \SimpleXMLEl
if (isset($metadata->docTags['@deprecated'])) {
$documentation .= "\n@deprecated " . $metadata->docTags['@deprecated'];
}
// Add links from "@see" annotations. No HTML formatting means
// non-clickable links, but copy+paste from a URL is then possible
// for further reading
if (isset($metadata->docTags['@see'])) {
$documentation .= "\n@see " . $metadata->docTags['@see'];
}
$documentation = trim($documentation);

// Add documentation to xml
Expand Down
55 changes: 55 additions & 0 deletions tests/Unit/Schema/SchemaGeneratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,61 @@ public static function generateSchemaDataProvider(): iterable
'</xsd:element>' .
'</xsd:schema>' . "\n",
],
'deprecatedViewHelperWithFurtherReading' => [
'http://typo3.org/ns/Vendor/Package/ViewHelpers',
[
new ViewHelperMetadata(
'Vendor\\Package\\ViewHelpers\\MyViewHelper',
'Vendor\\Package',
'MyViewHelper',
'myViewHelper',
'',
'http://typo3.org/ns/Vendor/Package/ViewHelpers',
[
'@deprecated' => 'since 1.2.3, will be removed in 2.0.0',
'@see' => 'https://docs.typo3.org/somelink',
],
[],
false,
),
],
'<?xml version="1.0" encoding="UTF-8"?>' . "\n" .
'<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://typo3.org/ns/Vendor/Package/ViewHelpers">' .
'<xsd:element name="myViewHelper">' .
'<xsd:annotation><xsd:documentation><![CDATA[@deprecated since 1.2.3, will be removed in 2.0.0' . "\n" . '@see https://docs.typo3.org/somelink]]></xsd:documentation></xsd:annotation>' .
'<xsd:complexType mixed="true">' .
'<xsd:sequence><xsd:any minOccurs="0"/></xsd:sequence>' .
'</xsd:complexType>' .
'</xsd:element>' .
'</xsd:schema>' . "\n",
],
'viewHelperWithFurtherReading' => [
'http://typo3.org/ns/Vendor/Package/ViewHelpers',
[
new ViewHelperMetadata(
'Vendor\\Package\\ViewHelpers\\MyViewHelper',
'Vendor\\Package',
'MyViewHelper',
'myViewHelper',
'',
'http://typo3.org/ns/Vendor/Package/ViewHelpers',
[
'@see' => 'https://docs.typo3.org/somelink',
],
[],
false,
),
],
'<?xml version="1.0" encoding="UTF-8"?>' . "\n" .
'<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://typo3.org/ns/Vendor/Package/ViewHelpers">' .
'<xsd:element name="myViewHelper">' .
'<xsd:annotation><xsd:documentation><![CDATA[@see https://docs.typo3.org/somelink]]></xsd:documentation></xsd:annotation>' .
'<xsd:complexType mixed="true">' .
'<xsd:sequence><xsd:any minOccurs="0"/></xsd:sequence>' .
'</xsd:complexType>' .
'</xsd:element>' .
'</xsd:schema>' . "\n",
],
'argumentTypes' => [
'http://typo3.org/ns/Vendor/Package/ViewHelpers',
[
Expand Down