Skip to content

Update phpdoc.md #84

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.

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
merged 1 commit into from
Aug 14, 2015
Merged
Changes from all commits
Commits
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: 3 additions & 3 deletions proposed/phpdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -1306,7 +1306,7 @@ The @param tag MAY have a multi-line description and does not need explicit
delimiting.

It is RECOMMENDED when documenting to use this tag with every function and
method. Exceptions to this recommendation are:
method.

This tag MUST NOT occur more than once per parameter in a "PHPDoc" and is
limited to "Structural Elements" of type method or function.
Expand All @@ -1317,7 +1317,7 @@ limited to "Structural Elements" of type method or function.
/**
* Counts the number of items in the provided array.
*
* @param mixed[] $array Array structure to count the elements of.
* @param mixed[] $items Array structure to count the elements of.
*
* @return int Returns the number of elements.
*/
Expand All @@ -1328,7 +1328,7 @@ function count(array $items)
```

The following example demonstrates the use of an "Inline PHPDoc" to document
an option array with 2 elements: 'required' and 'label'.
an option array with two elements: 'required' and 'label'.

```php
/**
Expand Down