diff --git a/src/admin/class-footnotes-admin.php b/src/admin/class-footnotes-admin.php index 2809853..bfd1051 100644 --- a/src/admin/class-footnotes-admin.php +++ b/src/admin/class-footnotes-admin.php @@ -52,9 +52,9 @@ class Footnotes_Admin { /** * Initialize the class and set its properties. - - * @param string $plugin_name The name of this plugin. - * @param string $version The version of this plugin. + + * @param string $plugin_name The name of this plugin. + * @param string $version The version of this plugin. * * @since 2.8.0 */ @@ -140,7 +140,7 @@ class Footnotes_Admin { /** * Appends the Plugin links for display in the dashboard Plugins page. * - * @param string[] $links The default set of links to display. + * @param string[] $links The default set of links to display. * @return string[] The full set of links to display. * * @since 1.5.0 diff --git a/src/admin/class-footnotes-wysiwyg.php b/src/admin/class-footnotes-wysiwyg.php index 037ec59..90e8152 100644 --- a/src/admin/class-footnotes-wysiwyg.php +++ b/src/admin/class-footnotes-wysiwyg.php @@ -10,7 +10,7 @@ * @package footnotes\admin * @since 1.5.0 * @since 2.8.0 Rename file from `wysiwyg.php` to `class-footnotes-wysiwyg.php`, - * move from `class/` sub-directory to `admin/`. + * move from `class/` sub-directory to `admin/`. */ /** @@ -47,7 +47,7 @@ class Footnotes_WYSIWYG { /** * Append a new Button to the WYSIWYG editor of Posts and Pages. * - * @param string[] $p_arr_buttons Already-defined editor buttons. + * @param string[] $p_arr_buttons Already-defined editor buttons. * @return string[] * * @since 1.5.0 @@ -73,7 +73,7 @@ class Footnotes_WYSIWYG { /** * Includes the Plugins WYSIWYG editor script. * - * @param string[] $p_arr_plugins Scripts to be included by the editor. + * @param string[] $p_arr_plugins Scripts to be included by the editor. * @return string[] * * @since 1.5.0 diff --git a/src/admin/layout/class-footnotes-layout-engine.php b/src/admin/layout/class-footnotes-layout-engine.php index 7de4d72..a9610c2 100644 --- a/src/admin/layout/class-footnotes-layout-engine.php +++ b/src/admin/layout/class-footnotes-layout-engine.php @@ -4,13 +4,13 @@ * * The Admin. Layouts subpackage is composed of the {@see Footnotes_Layout_Engine} * abstract class, which is extended by the {@see Footnotes_Layout_Settings} - * sub-class. The subpackage is initialised at runtime by the {@see + * sub-class. The subpackage is initialised at runtime by the {@see * Footnotes_Layout_Init} class. * * @package footnotes\admin_layout * @since 1.5.0 * @since 2.8.0 Rename file from `layout.php` to `class-footnotes-layout-engine.php`, - * rename `dashboard/` sub-directory to `layout/`. + * rename `dashboard/` sub-directory to `layout/`. */ require_once plugin_dir_path( dirname( __FILE__ ) ) . 'layout/class-footnotes-layout-init.php'; @@ -19,7 +19,7 @@ require_once plugin_dir_path( dirname( __FILE__ ) ) . 'layout/class-footnotes-la * Class to be extended by page layout sub-classes. * * @abstract - + * @package footnotes\admin_layout * @since 1.5.0 */ @@ -113,11 +113,11 @@ abstract class Footnotes_Layout_Engine { * Returns an array describing a sub-page section. * * @access protected - * @param string $p_str_id Unique ID suffix. - * @param string $p_str_title Title of the section. - * @param int $p_int_settings_container_index Settings Container index. - * @param bool $p_bool_has_submit_button Whether a ‘Submit’ button should - * be displayed for this section. Default `true`. + * @param string $p_str_id Unique ID suffix. + * @param string $p_str_title Title of the section. + * @param int $p_int_settings_container_index Settings Container index. + * @param bool $p_bool_has_submit_button Whether a ‘Submit’ button should + * be displayed for this section. Default `true`. * @return array { * A dashboard section. * @@ -143,10 +143,10 @@ abstract class Footnotes_Layout_Engine { * Returns an array describing a meta box. * * @access protected - * @param string $p_str_section_id Parent section ID. - * @param string $p_str_id Unique ID suffix. - * @param string $p_str_title Title for the meta box. - * @param string $p_str_callback_function_name Class method name for callback. + * @param string $p_str_section_id Parent section ID. + * @param string $p_str_id Unique ID suffix. + * @param string $p_str_title Title for the meta box. + * @param string $p_str_callback_function_name Class method name for callback. * @return array { * A dashboard meta box. * @@ -218,7 +218,7 @@ abstract class Footnotes_Layout_Engine { * Registers all Meta boxes for a sub-page. * * @access private - * @param string $p_str_parent_id Parent section unique ID. + * @param string $p_str_parent_id Parent section unique ID. * * @since 1.5.0 */ @@ -369,7 +369,7 @@ abstract class Footnotes_Layout_Engine { * Loads a specified setting. * * @access protected - * @param string $p_str_setting_key_name Setting key. + * @param string $p_str_setting_key_name Setting key. * @return array { * A configurable setting. * @@ -391,12 +391,12 @@ abstract class Footnotes_Layout_Engine { $p_arr_return['value'] = esc_attr( Footnotes_Settings::instance()->get( $p_str_setting_key_name ) ); return $p_arr_return; } - + /** * Returns a simple text inside HTML `` element. * * @access protected - * @param string $p_str_text Message to be surrounded with `` tags. + * @param string $p_str_text Message to be surrounded with `` tags. * @return string * * @since 1.5.0 @@ -410,8 +410,8 @@ abstract class Footnotes_Layout_Engine { * Returns the HTML tag for an ``/`` element. * * @access protected - * @param string $p_str_setting_name Setting key. - * @param int $p_str_max_length Maximum length of the input. Default length 999 chars. - * @param bool $p_bool_readonly Set the input to be read only. Default `false`. - * @param bool $p_bool_hidden Set the input to be hidden. Default `false`. + * @param string $p_str_setting_name Setting key. + * @param int $p_str_max_length Maximum length of the input. Default length 999 chars. + * @param bool $p_bool_readonly Set the input to be read only. Default `false`. + * @param bool $p_bool_hidden Set the input to be hidden. Default `false`. * @return string * * @since 1.5.0 @@ -471,7 +471,7 @@ abstract class Footnotes_Layout_Engine { * Constructs the HTML for a checkbox `` element. * * @access protected - * @param string $p_str_setting_name Setting key. + * @param string $p_str_setting_name Setting key. * @return string * * @since 1.5.0 @@ -492,7 +492,7 @@ abstract class Footnotes_Layout_Engine { * Constructs the HTML for a `