Skip to content

Commit

Permalink
doc(php): adjust several argument definition
Browse files Browse the repository at this point in the history
* Fix PHPDoc in FileLoader

* Fix PHPDoc in Oembed

* Fix PHPDoc in Options
  • Loading branch information
szepeviktor authored Sep 4, 2020
1 parent 7aabaef commit b7f64f9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions lib/Utils/FileLoader.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ class FileLoader
*
* @since 0.1.0
*
* @param $dir string Absolute path to the directory.
* @param $callback callable The callback function.
* @param string $dir Absolute path to the directory.
* @param callable $callback The callback function.
*
* @return array An array of the callback results.
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/Utils/Oembed.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ class Oembed
*
* @since 0.2.0
*
* @param $iframeTagHtml string The oembed iframe HTML tag.
* @param $additionalGetParams array Associative array of key/values of additional query variables to append to the url.
* @param string $iframeTagHtml The oembed iframe HTML tag.
* @param array $additionalGetParams Associative array of key/values of additional query variables to append to the url.
*
* @return string The modified oembed iframe HTML tag.
*/
Expand Down
5 changes: 2 additions & 3 deletions lib/Utils/Options.php
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,8 @@ public static function getGlobal($scope, $fieldName = null)
* @since 0.2.2 added check for required hooks to have run to alert of timing issues when used incorrectly
*
* @param string $optionType Type of option page. Either global or translatable.
* @param string $optionCategory Category of option page. One of these three values: component, feature, customPostType.
* @param string $subPageName Name of the sub page.
* @param string $fieldName (optional) Name of the field to get.
* @param string $scope Scope of the option.
* @param string|null $fieldName (optional) Name of the field to get.
* @return mixed The value of the option or array of options. False if subpage doesn't exist or no option was found.
**/
public static function get($optionType, $scope, $fieldName = null)
Expand Down

0 comments on commit b7f64f9

Please # to comment.