Docs: Ignore HTML API internals from public documentation

[sirreal]

The HTML API relies on many private and internal methods and classes. All of theme appear in the public documentation. This introduces a lot of noise into the documentation that's irrelevant for anyone not working directly on the HTML API itself.

By adding ignore annotations to most of the internal and private methods and classes, the documentation will be much cleaner and more relevant.

See the HTML processor class methods page for example. None of these internal methods should be of interest to folks using the HTML API:

I have kept a few "internal" things documented, like the WP_HTML_Text_Replacement and WP_HTML_Span which are often useful for subclasses working with bookmarks and replacements.

wordpress-develop/src/wp-includes/html-api/class-wp-html-text-replacement.php

Lines 16 to 22 in 33ebdd7

	* @access private
	* @since 6.2.0
	* @since 6.5.0 Replace `end` with `length` to more closely match `substr()`.
	*
	* @see WP_HTML_Tag_Processor
	*/
	class WP_HTML_Text_Replacement {

wordpress-develop/src/wp-includes/html-api/class-wp-html-span.php

Lines 19 to 25 in 33ebdd7

	* @access private
	* @since 6.2.0
	* @since 6.5.0 Replaced `end` with `length` to more closely align with `substr()`.
	*
	* @see WP_HTML_Tag_Processor
	*/
	class WP_HTML_Span {

Trac ticket:https://core.trac.wordpress.org/ticket/64224

---

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props jonsurrell, westonruter.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[westonruter]

Does the docs generator not ignore @access private symbols?

[sirreal]

Does the docs generator not ignore @access private symbols?

No, it doesn't seem to. @ignore is used to hide things from public documentation.

@access private seems to add a notice to methods, but not to classes. I've created WordPress/phpdoc-parser#255 for this.

(I also noticed that private methods may include confusing recommendations from @see annotations).

[sirreal]

Merged in r61793.