Skip to content

Commit 969385c

Browse files
committed
slight adjustments in uses tag
1 parent 9c781d4 commit 969385c

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

proposed/phpdoc-tags.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -895,28 +895,24 @@ Indicates whether the current "Structural Element" consumes the
895895

896896
#### Syntax
897897

898-
@uses [file | "FQSEN"] [<description>]
898+
@uses ["FQSEN"] [<description>]
899899

900900
#### Description
901901

902-
The `@uses` tag describes whether any part of the associated "Structural Element"
903-
uses, or consumes, another "Structural Element" or a file that is situated in
902+
The `@uses` tag describes whether any part of the associated "Structural
903+
Element" uses, or consumes, another "Structural Element" that is situated in
904904
the current project.
905905

906906
When defining a reference to another "Structural Element" you can refer to a
907907
specific element by appending a double colon and providing the name of that
908908
element (also called the "FQSEN").
909909

910-
Files that are contained in this project can be referred to by this tag. This
911-
can be used, for example, to indicate a relationship between a Controller and
912-
a template file (as View).
913-
914910
This tag MUST NOT be used to indicate relations to elements outside of the
915911
system, so URLs are not usable. To indicate relations with outside elements the
916912
@see tag can be used.
917913

918914
Applications consuming this tag, such as generators, are RECOMMENDED to provide
919-
a `@used-by` tag on the destination element. This can be used to provide a
915+
a `@usedby` tag on the destination element. This can be used to provide a
920916
bi-directional experience and allow for static analysis.
921917

922918
#### Examples
@@ -931,6 +927,7 @@ function initializeXml()
931927
}
932928
```
933929

930+
<<<<<<< HEAD
934931
```php
935932
/**
936933
* @uses MyView.php

0 commit comments

Comments
 (0)