Changeset 34939

Timestamp:

10/08/2015 04:46:16 PM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Remove invalid inline @link tags from a variety of DocBlocks in WP_Rewrite.

See #34218.

File:

• trunk/src/wp-includes/class-wp-rewrite.php (modified) (15 diffs)

trunk/src/wp-includes/class-wp-rewrite.php

@@ -164 +164 @@
          *
          * If PATHINFO/index permalinks are in use then the root is the value of
-         * {@link WP_Rewrite::$index} with a trailing slash appended. Otherwise
-         * the root will be empty.
+         * `WP_Rewrite::$index` with a trailing slash appended. Otherwise the root
+         * will be empty.
          *
          * @see WP_Rewrite::init()
@@ -227 +227 @@
          *
          * These rules are written to the mod_rewrite portion of the .htaccess,
-         * and are added by {@link add_external_rule()}.
+         * and are added by add_external_rule().
          *
          * @since 2.1.0
@@ -236 +236 @@
 
         /**
-         * Extra permalink structures, e.g. categories, added by {@link add_permastruct()}.
+         * Extra permalink structures, e.g. categories, added by add_permastruct().
          *
          * @since 2.1.0
@@ -245 +245 @@
 
         /**
-         * Endpoints (like /trackback/) added by {@link add_rewrite_endpoint()}.
+         * Endpoints (like /trackback/) added by add_rewrite_endpoint().
          *
          * @since 2.1.0
@@ -273 +273 @@
          * set to true. Prior to WordPress 3.3 this flag indicated that every page
          * would have a set of rules added to the top of the rewrite rules array.
-         * Now it tells {@link WP::parse_request()} to check if a URL matching the
-         * page permastruct is actually a page before accepting it.
-         *
-         * @link https://core.trac.wordpress.org/ticket/16687
+         * Now it tells WP::parse_request() to check if a URL matching the page
+         * permastruct is actually a page before accepting it.
+         *
+         * @since 2.5.0
+         * @access public
+         * @var bool
+         *
          * @see WP_Rewrite::init()
-         * @since 2.5.0
-         * @access public
-         * @var bool
          */
         public $use_verbose_page_rules = true;
@@ -288 +288 @@
          *
          * These are translated into the regular expressions stored in
-         * {@link WP_Rewrite::$rewritereplace} and are rewritten to the
-         * query variables listed in {@link WP_Rewrite::$queryreplace}.
-         *
-         * Additional tags can be added with {@link add_rewrite_tag()}.
+         * `WP_Rewrite::$rewritereplace` and are rewritten to the query
+         * variables listed in WP_Rewrite::$queryreplace.
+         *
+         * Additional tags can be added with add_rewrite_tag().
          *
          * @since 1.5.0
@@ -313 +313 @@
         /**
          * Regular expressions to be substituted into rewrite rules in place
-         * of rewrite tags, see {@link WP_Rewrite::$rewritecode}.
+         * of rewrite tags, see WP_Rewrite::$rewritecode.
          *
          * @since 1.5.0
@@ -334 +334 @@
 
         /**
-         * Query variables that rewrite tags map to, see {@link WP_Rewrite::$rewritecode}.
+         * Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.
          *
          * @since 1.5.0
@@ -1139 +1139 @@
          * Generate Rewrite rules with permalink structure and walking directory only.
          *
-         * Shorten version of {@link WP_Rewrite::generate_rewrite_rules()} that
-         * allows for shorter list of parameters. See the method for longer
-         * description of what generating rewrite rules does.
-         *
-         * @uses WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
-         * @since 1.5.0
-         * @access public
+         * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter
+         * list of parameters. See the method for longer description of what generating
+         * rewrite rules does.
+         *
+         * @since 1.5.0
+         * @access public
+         *
+         * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
          *
          * @param string $permalink_structure The permalink structure to generate rules.
@@ -1364 +1365 @@
          * Retrieve the rewrite rules.
          *
-         * The difference between this method and {@link
-         * WP_Rewrite::rewrite_rules()} is that this method stores the rewrite rules
-         * in the 'rewrite_rules' option and retrieves it. This prevents having to
-         * process all of the permalinks to get the rewrite rules in the form of
-         * caching.
+         * The difference between this method and WP_Rewrite::rewrite_rules() is that
+         * this method stores the rewrite rules in the 'rewrite_rules' option and retrieves
+         * it. This prevents having to process all of the permalinks to get the rewrite rules
+         * in the form of caching.
          *
          * @since 1.5.0
@@ -1623 +1623 @@
          * Add a new permalink structure.
          *
-         * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules; it
-         * is an easy way of expressing a set of regular expressions that rewrite to a set of query strings.
-         * The new permastruct is added to the {@link WP_Rewrite::$extra_permastructs} array. When the
-         * rewrite rules are built by {@link WP_Rewrite::rewrite_rules()} all of these extra permastructs
-         * are passed to {@link WP_Rewrite::generate_rewrite_rules()} which transforms them into the
-         * regular expressions that many love to hate.
-         *
-         * The $args parameter gives you control over how {@link WP_Rewrite::generate_rewrite_rules()}
+         * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules;
+         * it is an easy way of expressing a set of regular expressions that rewrite to a set of
+         * query strings. The new permastruct is added to the WP_Rewrite::$extra_permastructs array.
+         * When the rewrite rules are built by WP_Rewrite::rewrite_rules(), all of these extra
+         * permastructs are passed to WP_Rewrite::generate_rewrite_rules() which transforms them
+         * into the regular expressions that many love to hate.
+         *
+         * The `$args` parameter gives you control over how WP_Rewrite::generate_rewrite_rules()
          * works on the new permastruct.
          *
@@ -1679 +1679 @@
          * Remove rewrite rules and then recreate rewrite rules.
          *
-         * Calls {@link WP_Rewrite::wp_rewrite_rules()} after removing the
-         * 'rewrite_rules' option. If the function named 'save_mod_rewrite_rules'
-         * exists, it will be called.
+         * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.
+         * If the function named 'save_mod_rewrite_rules' exists, it will be called.
          *
          * @since 2.0.1
@@ -1762 +1761 @@
          * Will update the 'permalink_structure' option, if there is a difference
          * between the current permalink structure and the parameter value. Calls
-         * {@link WP_Rewrite::init()} after the option is updated.
+         * WP_Rewrite::init() after the option is updated.
          *
          * Fires the 'permalink_structure_changed' action once the init call has
@@ -1794 +1793 @@
          *
          * Will update the 'category_base' option, if there is a difference between
-         * the current category base and the parameter value. Calls
-         * {@link WP_Rewrite::init()} after the option is updated.
+         * the current category base and the parameter value. Calls WP_Rewrite::init()
+         * after the option is updated.
          *
          * @since 1.5.0
@@ -1813 +1812 @@
          *
          * Will update the 'tag_base' option, if there is a difference between the
-         * current tag base and the parameter value. Calls
-         * {@link WP_Rewrite::init()} after the option is updated.
+         * current tag base and the parameter value. Calls WP_Rewrite::init() after
+         * the option is updated.
          *
          * @since 2.3.0