-
Notifications
You must be signed in to change notification settings - Fork 438
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: address suggestions from docfx review (#5767)
* ensure parameter descriptions are also decoded * strip generated from protobuf field * typo fix * fix RetrySettings references in VisionClient * fix two more bad references * chore(docs): fidx newlines, add template overrides * chore(docs): use HEAD for phpDocumentor for unreleased bug fixes
- Loading branch information
Showing
114 changed files
with
3,508 additions
and
6,852 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| {# @var argument \phpDocumentor\Descriptor\ArgumentDescriptor #} | ||
| <argument line="{{ argument.line }}" by_reference="{{ argument.byReference | export }}"> | ||
| <name>{{ argument.name }}</name> | ||
| <default>{{ argument.default }}</default> | ||
| <type>{{ argument.type }}</type> | ||
| </argument> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| {# @var constant phpDocumentor\Descriptor\ConstantDescriptor #} | ||
| <constant namespace="{{ constant.namespace }}" line="{{ constant.line }}" visibility="{{ constant.visibility }}"> | ||
| <name>{{ constant.name }}</name> | ||
| <full_name>{{ constant.fullyQualifiedStructuralElementName }}</full_name> | ||
| <value>{{ constant.value }}</value> | ||
| {% if inherited_from %}<inherited_from>{{ inherited_from }}</inherited_from>{% endif %} | ||
| {{ include('docblock.xml.twig', {descriptor: constant}) }} | ||
| </constant> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| {# @var descriptor \phpDocumentor\Descriptor\DescriptorAbstract #} | ||
| <docblock line="{{ descriptor.line }}"> | ||
| <description>{{ descriptor.summary }}</description> | ||
| <long-description>{{ descriptor.description }}</long-description> | ||
| {% for tags in descriptor.tags %} | ||
| {% for tag in tags %} | ||
| {% apply spaceless %} | ||
| <tag | ||
| name="{{ tag.name }}" | ||
| description="{{ tag.description|e|replace({"\n": " "})|raw }}" | ||
| {% if tag.link %} link="{{ tag.link }}"{% endif %} | ||
| {% if tag.version %} version="{{ tag.version }}"{% endif %} | ||
| {% if tag.reference %} link="{{ tag.reference }}"{% endif %} | ||
| {% if tag.variableName %} variable="{{ tag.variableName }}"{% endif %} | ||
| {% if tag.methodName %} method_name="{{ tag.methodName }}"{% endif %} | ||
| {% if tag.type %} type="{{ tag.type }}"{% endif %}/> | ||
| {% endapply %} | ||
|
|
||
| {% endfor %} | ||
| {% endfor %} | ||
| </docblock> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| {# @var method phpDocumentor\Descriptor\MethodDescriptor #} | ||
| <method final="{{ method.final | export }}" abstract="{{ method.abstract | export }}" static="{{ method.static | export }}" namespace="{{ method.namespace }}" line="{{ method.line }}" visibility="{{ method.visibility }}" returnByReference="{{ method.hasReturnByReference | export }}"> | ||
| <name>{{ method.name }}</name> | ||
| <full_name>{{ method.fullyQualifiedStructuralElementName }}</full_name> | ||
| <value>{{ method.value }}</value> | ||
| {% if inherited_from %}<inherited_from>{{ inherited_from }}</inherited_from>{% endif %} | ||
| {% for argument in method.arguments %} | ||
| {{ include('argument.xml.twig', {descriptor: argument}) }} | ||
| {% endfor %} | ||
| {{ include('docblock.xml.twig', {descriptor: method}) }} | ||
| </method> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| {# @var namespace \phpDocumentor\Descriptor\NamespaceDescriptor #} | ||
| {% if namespace.children.count > 0 %} | ||
| <namespace name="{{ namespace.name }}" full_name="{{ namespace.fullyQualifiedStructuralElementName }}"> | ||
| {% for child in namespace.children %} | ||
| {{ include('namespace_tree.xml.twig', {namespace: child}) }} | ||
| {% endfor %} | ||
| </namespace> | ||
| {% else %} | ||
| <namespace name="{{ namespace.name }}" full_name="{{ namespace.fullyQualifiedStructuralElementName }}" /> | ||
| {% endif %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| {# @var property phpDocumentor\Descriptor\PropertyDescriptor #} | ||
| <property namespace="{{ property.namespace }}" line="{{ property.line }}" visibility="{{ property.visibility }}"> | ||
| <name>{{ property.name }}</name> | ||
| <full_name>{{ property.fullyQualifiedStructuralElementName }}</full_name> | ||
| <default>{{ property.default }}</default> | ||
| {% if inherited_from %}<inherited_from>{{ inherited_from }}</inherited_from>{% endif %} | ||
| {{ include('docblock.xml.twig', {descriptor: property}) }} | ||
| </property> |
Oops, something went wrong.