From 21ce200edb8bd72973bbee78abf62f66bf0b44c5 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 26 Oct 2019 00:34:10 +0000 Subject: [PATCH] Docs: Improve formatting of various `WP_Screen` DocBlocks. See #48303. git-svn-id: https://develop.svn.wordpress.org/trunk@46591 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-screen.php | 30 +++++++++++++++++------ 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/src/wp-admin/includes/class-wp-screen.php b/src/wp-admin/includes/class-wp-screen.php index ec1cf917c3..8d270e473e 100644 --- a/src/wp-admin/includes/class-wp-screen.php +++ b/src/wp-admin/includes/class-wp-screen.php @@ -14,7 +14,9 @@ */ final class WP_Screen { /** - * Any action associated with the screen. 'add' for *-add.php and *-new.php screens. Empty otherwise. + * Any action associated with the screen. + * + * 'add' for *-add.php and *-new.php screens. Empty otherwise. * * @since 3.3.0 * @var string @@ -22,8 +24,10 @@ final class WP_Screen { public $action; /** - * The base type of the screen. This is typically the same as $id but with any post types and taxonomies stripped. - * For example, for an $id of 'edit-post' the base is 'edit'. + * The base type of the screen. + * + * This is typically the same as `$id` but with any post types and taxonomies stripped. + * For example, for an `$id` of 'edit-post' the base is 'edit'. * * @since 3.3.0 * @var string @@ -78,8 +82,10 @@ final class WP_Screen { /** * The base menu parent. - * This is derived from $parent_file by removing the query string and any .php extension. - * $parent_file values of 'edit.php?post_type=page' and 'edit.php?post_type=post' have a $parent_base of 'edit'. + * + * This is derived from `$parent_file` by removing the query string and any .php extension. + * `$parent_file` values of 'edit.php?post_type=page' and 'edit.php?post_type=post' + * have a `$parent_base` of 'edit'. * * @since 3.3.0 * @var string @@ -88,7 +94,8 @@ final class WP_Screen { /** * The parent_file for the screen per the admin menu system. - * Some $parent_file values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'. + * + * Some `$parent_file` values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'. * * @since 3.3.0 * @var string @@ -97,6 +104,7 @@ final class WP_Screen { /** * The post type associated with the screen, if any. + * * The 'edit.php?post_type=page' screen has a post type of 'page'. * The 'edit-tags.php?taxonomy=$taxonomy&post_type=page' screen has a post type of 'page'. * @@ -107,6 +115,7 @@ final class WP_Screen { /** * The taxonomy associated with the screen, if any. + * * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'. * * @since 3.3.0 @@ -466,6 +475,7 @@ final class WP_Screen { /** * Set the parent information for the screen. + * * This is called in admin-header.php after the menu parent for the screen has been determined. * * @since 3.3.0 @@ -480,7 +490,9 @@ final class WP_Screen { /** * Adds an option for the screen. - * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add screen options. + * + * Call this in template files after admin.php is loaded and before admin-header.php is loaded + * to add screen options. * * @since 3.3.0 * @@ -670,7 +682,9 @@ final class WP_Screen { /** * Add a sidebar to the contextual help for the screen. - * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help. + * + * Call this in template files after admin.php is loaded and before admin-header.php is loaded + * to add a sidebar to the contextual help. * * @since 3.3.0 *