File tree Expand file tree Collapse file tree 1 file changed +7
-2
lines changed Expand file tree Collapse file tree 1 file changed +7
-2
lines changed Original file line number Diff line number Diff line change @@ -368,7 +368,7 @@ Mark a function that has been generated using a PHP script.
368
368
/**
369
369
* @generated function generated using bin/script.php, please DO NOT EDIT!
370
370
*
371
- * @params array $params parameters for the index API endpoint
371
+ * @param array $params parameters for the index API endpoint
372
372
*
373
373
* @return array response from Elasticsearch
374
374
*/
@@ -594,7 +594,7 @@ The @param tag is used to document a single parameter of a function or method.
594
594
595
595
#### Syntax
596
596
597
- @param ["Type"] $[name] [<description>]
597
+ @param ["Type"] [...] $[name] [<description>]
598
598
599
599
#### Description
600
600
@@ -604,6 +604,11 @@ single parameter of a function or method. When provided it MUST contain a
604
604
@param tags are omitted due to all useful info already being visible in the
605
605
code signature itself. The description is OPTIONAL yet RECOMMENDED.
606
606
607
+ The name of the parameter MUST be prefixed with a dollar sign (` $ ` ) to indicate
608
+ the start of a variable name. OPTIONAL the variadic operator (` ... ` ) MAY be used
609
+ to indicate that the parameter is variadic. The variadic operator MAY only be
610
+ applied to the last parameter.
611
+
607
612
It is RECOMMENDED when documenting to use this tag with every function and
608
613
method.
609
614
You can’t perform that action at this time.
0 commit comments