Skip to content

Commit 2683f49

Browse files
author
Chris Wilcoxson
committed
Function docs should be @param not @var.
1 parent 474e649 commit 2683f49

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

plugin-name/trunk/admin/class-plugin-name-admin.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ class Plugin_Name_Admin {
4444
* Initialize the class and set its properties.
4545
*
4646
* @since 1.0.0
47-
* @var string $plugin_name The name of this plugin.
48-
* @var string $version The version of this plugin.
47+
* @param string $plugin_name The name of this plugin.
48+
* @param string $version The version of this plugin.
4949
*/
5050
public function __construct( $plugin_name, $version ) {
5151

plugin-name/trunk/includes/class-plugin-name-loader.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ public function __construct() {
5757
* Add a new action to the collection to be registered with WordPress.
5858
*
5959
* @since 1.0.0
60-
* @var string $hook The name of the WordPress action that is being registered.
61-
* @var object $component A reference to the instance of the object on which the action is defined.
62-
* @var string $callback The name of the function definition on the $component.
63-
* @var int Optional $priority The priority at which the function should be fired.
64-
* @var int Optional $accepted_args The number of arguments that should be passed to the $callback.
60+
* @param string $hook The name of the WordPress action that is being registered.
61+
* @param object $component A reference to the instance of the object on which the action is defined.
62+
* @param string $callback The name of the function definition on the $component.
63+
* @param int Optional $priority The priority at which the function should be fired.
64+
* @param int Optional $accepted_args The number of arguments that should be passed to the $callback.
6565
*/
6666
public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
6767
$this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args );
@@ -71,11 +71,11 @@ public function add_action( $hook, $component, $callback, $priority = 10, $accep
7171
* Add a new filter to the collection to be registered with WordPress.
7272
*
7373
* @since 1.0.0
74-
* @var string $hook The name of the WordPress filter that is being registered.
75-
* @var object $component A reference to the instance of the object on which the filter is defined.
76-
* @var string $callback The name of the function definition on the $component.
77-
* @var int Optional $priority The priority at which the function should be fired.
78-
* @var int Optional $accepted_args The number of arguments that should be passed to the $callback.
74+
* @param string $hook The name of the WordPress filter that is being registered.
75+
* @param object $component A reference to the instance of the object on which the filter is defined.
76+
* @param string $callback The name of the function definition on the $component.
77+
* @param int Optional $priority The priority at which the function should be fired.
78+
* @param int Optional $accepted_args The number of arguments that should be passed to the $callback.
7979
*/
8080
public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
8181
$this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args );
@@ -87,12 +87,12 @@ public function add_filter( $hook, $component, $callback, $priority = 10, $accep
8787
*
8888
* @since 1.0.0
8989
* @access private
90-
* @var array $hooks The collection of hooks that is being registered (that is, actions or filters).
91-
* @var string $hook The name of the WordPress filter that is being registered.
92-
* @var object $component A reference to the instance of the object on which the filter is defined.
93-
* @var string $callback The name of the function definition on the $component.
94-
* @var int Optional $priority The priority at which the function should be fired.
95-
* @var int Optional $accepted_args The number of arguments that should be passed to the $callback.
90+
* @param array $hooks The collection of hooks that is being registered (that is, actions or filters).
91+
* @param string $hook The name of the WordPress filter that is being registered.
92+
* @param object $component A reference to the instance of the object on which the filter is defined.
93+
* @param string $callback The name of the function definition on the $component.
94+
* @param int Optional $priority The priority at which the function should be fired.
95+
* @param int Optional $accepted_args The number of arguments that should be passed to the $callback.
9696
* @return type The collection of actions and filters registered with WordPress.
9797
*/
9898
private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {

plugin-name/trunk/public/class-plugin-name-public.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ class Plugin_Name_Public {
4444
* Initialize the class and set its properties.
4545
*
4646
* @since 1.0.0
47-
* @var string $plugin_name The name of the plugin.
48-
* @var string $version The version of this plugin.
47+
* @param string $plugin_name The name of the plugin.
48+
* @param string $version The version of this plugin.
4949
*/
5050
public function __construct( $plugin_name, $version ) {
5151

0 commit comments

Comments
 (0)