Ensure we're using the correct @ignore phpDocumentor tag to mark elements that should be skipped when parsing.

Up to this point, various core elements' DocBlocks incorrectly included an `@internal` tag as a means for skipping the parsing process. When paired with a description (inline or otherwise), `@internal` is a valid tag meant to provide internal-only context, but not necessarily to skip parsing the entire element.

See #30987.


git-svn-id: https://develop.svn.wordpress.org/trunk@31170 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture)
2015-01-13 00:50:32 +00:00
parent 1f9ee350fc
commit 9b0cf1bd5b
5 changed files with 16 additions and 12 deletions

View File

@@ -94,7 +94,7 @@ foreach ( $crons as $timestamp => $cronhooks ) {
/**
* Fires scheduled events.
*
* @internal
* @ignore
* @since 2.1.0
*
* @param string $hook Name of the hook that was scheduled to be fired.