WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Improve HTML API file and class headers per the documentation standards. 

Follow-up to [55203], [55304], [55718], [55724], [55727].

See #57840.
Built from https://develop.svn.wordpress.org/trunk@55734


git-svn-id: http://core.svn.wordpress.org/trunk@55246 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2023-05-09 11:19:21 +00:00
parent 5da872aa27
commit 5e0592d8f4
6 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
wp-includes/html-api/class-wp-html-attribute-token.php
View File

@ -1,6 +1,6 @@
<?php <?php
/** /**
* HTML Tag Processor: Attribute token structure class. * HTML API: WP_HTML_Attribute_Token class
* *
* @package WordPress * @package WordPress
* @subpackage HTML-API * @subpackage HTML-API
@ -8,7 +8,8 @@
*/ */
/** /**
* Data structure for the attribute token that allows to drastically improve performance. * Core class used by the HTML tag processor as a data structure for the attribute token,
* allowing to drastically improve performance.
* *
* This class is for internal usage of the WP_HTML_Tag_Processor class. * This class is for internal usage of the WP_HTML_Tag_Processor class.
* *

9
wp-includes/html-api/class-wp-html-span.php
View File

@ -1,6 +1,6 @@
<?php <?php
/** /**
* HTML Span: Represents a textual span inside an HTML document. * HTML API: WP_HTML_Span class
* *
* @package WordPress * @package WordPress
* @subpackage HTML-API * @subpackage HTML-API
@ -8,10 +8,11 @@
*/ */
/** /**
* Represents a textual span inside an HTML document. * Core class used by the HTML tag processor to represent a textual span
* inside an HTML document.
* *
* This is a two-tuple in disguise, used to avoid the memory * This is a two-tuple in disguise, used to avoid the memory overhead
* overhead involved in using an array for the same purpose. * involved in using an array for the same purpose.
* *
* This class is for internal usage of the WP_HTML_Tag_Processor class. * This class is for internal usage of the WP_HTML_Tag_Processor class.
* *

4
wp-includes/html-api/class-wp-html-tag-processor.php
View File

@ -1,5 +1,7 @@
<?php <?php
/** /**
* HTML API: WP_HTML_Tag_Processor class
*
* Scans through an HTML document to find specific tags, then * Scans through an HTML document to find specific tags, then
* transforms those tags by adding, removing, or updating the * transforms those tags by adding, removing, or updating the
* values of the HTML attributes within that tag (opener). * values of the HTML attributes within that tag (opener).
@ -27,7 +29,7 @@
*/ */
/** /**
* Modifies attributes in an HTML document for tags matching a query. * Core class used to modify attributes in an HTML document for tags matching a query.
* *
* ## Usage * ## Usage
* *

5
wp-includes/html-api/class-wp-html-text-replacement.php
View File

@ -1,6 +1,6 @@
<?php <?php
/** /**
* HTML Tag Processor: Text replacement class. * HTML API: WP_HTML_Text_Replacement class
* *
* @package WordPress * @package WordPress
* @subpackage HTML-API * @subpackage HTML-API
@ -8,7 +8,8 @@
*/ */
/** /**
* Data structure used to replace existing content from start to end that allows to drastically improve performance. * Core class used by the HTML tag processor as a data structure for replacing
* existing content from start to end, allowing to drastically improve performance.
* *
* This class is for internal usage of the WP_HTML_Tag_Processor class. * This class is for internal usage of the WP_HTML_Tag_Processor class.
* *

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.3-alpha-55733'; $wp_version = '6.3-alpha-55734';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.