Skip to content

Commit b7efc9c

Browse files
authored
[TASK] Remove @see annotation from output (#965)
We cannot resolve links to remove the not-helpful annotation. Resolves #839
1 parent 56366ef commit b7efc9c

File tree

4 files changed

+35
-2
lines changed

4 files changed

+35
-2
lines changed

Documentation-rendertest/ViewHelpers/Index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ f:link.external
2222
.. typo3:viewhelper:: link.external
2323
:source: resources/global_viewhelpers_demo.json
2424

25+
26+
else
27+
====
28+
29+
.. typo3:viewhelper:: else
30+
:source: resources/global_viewhelpers_demo.json
31+
2532
f:deprecated
2633
============
2734

Documentation-rendertest/ViewHelpers/resources/global_viewhelpers_demo.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,33 @@
4141
"namespaceWithoutSuffix": "TYPO3Fluid\\Fluid",
4242
"uri": "Global\/Split"
4343
},
44+
45+
"else": {
46+
"className": "TYPO3Fluid\\Fluid\\ViewHelpers\\ElseViewHelper",
47+
"namespace": "TYPO3Fluid\\Fluid\\ViewHelpers",
48+
"name": "ElseViewHelper",
49+
"tagName": "else",
50+
"documentation": "Else-Branch of a condition. Only has an effect inside of ``f:if``.\nSee the ``f:if`` ViewHelper for documentation.\n\nExamples\n========\n\nOutput content if condition is not met\n--------------------------------------\n\n::\n\n <f:if condition=\"{someCondition}\">\n <f:else>\n condition was not true\n <\/f:else>\n <\/f:if>\n\nOutput::\n\n Everything inside the \"else\" tag is displayed if the condition evaluates to false.\n Otherwise, nothing is outputted in this example.",
51+
"xmlNamespace": "http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers",
52+
"docTags": {
53+
"@see": "TYPO3Fluid\\Fluid\\ViewHelpers\\IfViewHelper",
54+
"@api": ""
55+
},
56+
"argumentDefinitions": {
57+
"if": {
58+
"name": "if",
59+
"type": "boolean",
60+
"description": "Condition expression conforming to Fluid boolean rules",
61+
"required": false,
62+
"defaultValue": null,
63+
"escape": null
64+
}
65+
},
66+
"allowsArbitraryArguments": false,
67+
"nameWithoutSuffix": "Else",
68+
"namespaceWithoutSuffix": "TYPO3Fluid\\Fluid",
69+
"uri": "Global\/Else"
70+
},
4471
"link.external": {
4572
"className": "TYPO3\\CMS\\Fluid\\ViewHelpers\\Link\\ExternalViewHelper",
4673
"namespace": "TYPO3\\CMS\\Fluid\\ViewHelpers",

packages/typo3-docs-theme/resources/template/body/directive/viewhelper.html.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<p>This ViewHelper is marked as internal. It is subject to be
1616
changed without notice. Use at your own risk.</p>
1717
</div>
18-
{% elseif key == '@api' or key == '@todo' %}
18+
{% elseif key == '@see' or key == '@api' or key == '@todo' %}
1919
{% else %}
2020
<p>{{ key }}: {{ docTag }}</p>
2121
{% endif %}

tests/Integration/tests/viewhelper/viewhelper-all/expected/index.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,6 @@ <h3 class="sr-only">limit</h3>
436436
</section>
437437
<section class="section" id="f-link-external">
438438
<h2>f:link.external<a class="headerlink" href="#f-link-external" data-bs-toggle="modal" data-bs-target="#linkReferenceModal" title="Reference this headline"><i class="fa-solid fa-paragraph"></i></a></h2>
439-
<p>@see: https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-link-external</p>
440439

441440

442441

0 commit comments

Comments
 (0)