Skip to content

Commit

Permalink
Adjust styling to avoid using PHPDoc syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
dmsnell authored and ockham committed Aug 7, 2023
1 parent 266012f commit 1593b89
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public function remove_node( $token ) {
* > EM -> STRONG -> A ->
*
* To start with the most-recently added element and walk towards the top,
* {@see WP_HTML_Active_Formatting_Elements::walk_up}.
* see WP_HTML_Active_Formatting_Elements::walk_up().
*
* @since 6.4.0
*/
Expand All @@ -175,7 +175,7 @@ public function walk_down() {
* > A -> STRONG -> EM ->
*
* To start with the first added element and walk towards the bottom,
* {@see WP_HTML_Active_Formatting_Elements::walk_down}.
* see WP_HTML_Active_Formatting_Elements::walk_down().
*
* @since 6.4.0
*/
Expand Down
4 changes: 2 additions & 2 deletions src/wp-includes/html-api/class-wp-html-open-elements.php
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ public function remove_node( $token ) {
* > EM -> STRONG -> A ->
*
* To start with the most-recently added element and walk towards the top,
* {@see WP_HTML_Open_Elements::walk_up}.
* see WP_HTML_Open_Elements::walk_up().
*
* @since 6.4.0
*/
Expand All @@ -361,7 +361,7 @@ public function walk_down() {
* > A -> STRONG -> EM ->
*
* To start with the first added element and walk towards the bottom,
* {@see WP_HTML_Open_Elements::walk_down}.
* see WP_HTML_Open_Elements::walk_down().
*
* @since 6.4.0
*/
Expand Down
10 changes: 6 additions & 4 deletions src/wp-includes/html-api/class-wp-html-processor.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* unsupported markup, it aborts early to avoid unintentionally breaking
* the document. The HTML Processor should never break an HTML document.
*
* While the {@see WP_HTML_Tag_Processor} is a valuable tool for modifying
* While the `WP_HTML_Tag_Processor` is a valuable tool for modifying
* attributes on individual HTML tags, the HTML Processor is more capable
* and useful for the following operations:
*
Expand Down Expand Up @@ -47,7 +47,7 @@
*
* Breadcrumbs represent the stack of open elements from the root
* of the document or fragment down to the currently-matched node,
* if one is currently selected. Call {@see WP_HTML_Processor::get_breadcrumbs}
* if one is currently selected. Call WP_HTML_Processor::get_breadcrumbs()
* to inspect the breadcrumbs for a matched tag.
*
* Breadcrumbs can specify nested HTML structure and are equivalent
Expand Down Expand Up @@ -121,6 +121,7 @@
*
* @since 6.4.0
*
* @see WP_HTML_Tag_Processor
* @see https://html.spec.whatwg.org/
*/
class WP_HTML_Processor extends WP_HTML_Tag_Processor {
Expand Down Expand Up @@ -926,10 +927,11 @@ private function generate_implied_end_tags( $except_for_this_element = null ) {
* Closes elements that have implied end tags, thoroughly.
*
* See the HTML specification for an explanation why this is
* different from {@see WP_HTML_Processor::generate_implied_end_tags}.
* different from generating end tags in the normal sense.
*
* @since 6.4.0
*
* @see WP_HTML_Processor::generate_implied_end_tags
* @see https://html.spec.whatwg.org/#generate-implied-end-tags
*/
private function generate_implied_end_tags_thoroughly() {
Expand Down Expand Up @@ -1306,7 +1308,7 @@ public static function is_void( $tag_name ) {
/**
* Unlock code that must be passed into the constructor to create this class.
*
* This class extends {@see WP_HTML_Tag_Processor}, which has a public class
* This class extends the WP_HTML_Tag_Processor, which has a public class
* constructor. Therefore, it's not possible to have a private constructor here.
*
* This unlock code is used to ensure that anyone calling the constructor is
Expand Down
4 changes: 3 additions & 1 deletion src/wp-includes/html-api/class-wp-html-token.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,12 @@ class WP_HTML_Token {
/**
* Name of node; lowercase names such as "marker" are not HTML elements.
*
* For HTML elements/tags this value should come from {@see WP_HTML_Processor::get_tag}.
* For HTML elements/tags this value should come from WP_HTML_Processor::get_tag().
*
* @since 6.4.0
*
* @see WP_HTML_Processor::get_tag()
*
* @var string
*/
public $node_name = null;
Expand Down

0 comments on commit 1593b89

Please sign in to comment.