Docs: Mark the `upgrade_XX()` functions to be ignored from parsing for the Code Reference.

There is no great value in generating reference pages for these funcitons as they explicitly serve a core-only purpose.

See #32246.

Built from https://develop.svn.wordpress.org/trunk@35966


git-svn-id: http://core.svn.wordpress.org/trunk@35931 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-12-16 17:59:27 +00:00
parent 36367e7f6e
commit c9a11ae9f2
2 changed files with 31 additions and 1 deletions

View File

@ -447,6 +447,7 @@ endif;
* Contains conditional checks to determine which upgrade scripts to run, * Contains conditional checks to determine which upgrade scripts to run,
* based on database version and WP version being updated-to. * based on database version and WP version being updated-to.
* *
* @ignore
* @since 1.0.1 * @since 1.0.1
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -559,6 +560,7 @@ function upgrade_all() {
/** /**
* Execute changes made in WordPress 1.0. * Execute changes made in WordPress 1.0.
* *
* @ignore
* @since 1.0.0 * @since 1.0.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -617,6 +619,7 @@ function upgrade_100() {
/** /**
* Execute changes made in WordPress 1.0.1. * Execute changes made in WordPress 1.0.1.
* *
* @ignore
* @since 1.0.1 * @since 1.0.1
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -637,6 +640,7 @@ function upgrade_101() {
/** /**
* Execute changes made in WordPress 1.2. * Execute changes made in WordPress 1.2.
* *
* @ignore
* @since 1.2.0 * @since 1.2.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -699,6 +703,7 @@ function upgrade_110() {
/** /**
* Execute changes made in WordPress 1.5. * Execute changes made in WordPress 1.5.
* *
* @ignore
* @since 1.5.0 * @since 1.5.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -785,6 +790,7 @@ function upgrade_130() {
/** /**
* Execute changes made in WordPress 2.0. * Execute changes made in WordPress 2.0.
* *
* @ignore
* @since 2.0.0 * @since 2.0.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -871,6 +877,7 @@ function upgrade_160() {
/** /**
* Execute changes made in WordPress 2.1. * Execute changes made in WordPress 2.1.
* *
* @ignore
* @since 2.1.0 * @since 2.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -918,6 +925,7 @@ function upgrade_210() {
/** /**
* Execute changes made in WordPress 2.3. * Execute changes made in WordPress 2.3.
* *
* @ignore
* @since 2.3.0 * @since 2.3.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -1097,6 +1105,7 @@ function upgrade_230() {
/** /**
* Remove old options from the database. * Remove old options from the database.
* *
* @ignore
* @since 2.3.0 * @since 2.3.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -1113,6 +1122,7 @@ function upgrade_230_options_table() {
/** /**
* Remove old categories, link2cat, and post2cat database tables. * Remove old categories, link2cat, and post2cat database tables.
* *
* @ignore
* @since 2.3.0 * @since 2.3.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -1127,6 +1137,7 @@ function upgrade_230_old_tables() {
/** /**
* Upgrade old slugs made in version 2.2. * Upgrade old slugs made in version 2.2.
* *
* @ignore
* @since 2.2.0 * @since 2.2.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -1140,6 +1151,7 @@ function upgrade_old_slugs() {
/** /**
* Execute changes made in WordPress 2.5.0. * Execute changes made in WordPress 2.5.0.
* *
* @ignore
* @since 2.5.0 * @since 2.5.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1156,6 +1168,7 @@ function upgrade_250() {
/** /**
* Execute changes made in WordPress 2.5.2. * Execute changes made in WordPress 2.5.2.
* *
* @ignore
* @since 2.5.2 * @since 2.5.2
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -1169,6 +1182,7 @@ function upgrade_252() {
/** /**
* Execute changes made in WordPress 2.6. * Execute changes made in WordPress 2.6.
* *
* @ignore
* @since 2.6.0 * @since 2.6.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1183,6 +1197,7 @@ function upgrade_260() {
/** /**
* Execute changes made in WordPress 2.7. * Execute changes made in WordPress 2.7.
* *
* @ignore
* @since 2.7.0 * @since 2.7.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
@ -1202,6 +1217,7 @@ function upgrade_270() {
/** /**
* Execute changes made in WordPress 2.8. * Execute changes made in WordPress 2.8.
* *
* @ignore
* @since 2.8.0 * @since 2.8.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1232,6 +1248,7 @@ function upgrade_280() {
/** /**
* Execute changes made in WordPress 2.9. * Execute changes made in WordPress 2.9.
* *
* @ignore
* @since 2.9.0 * @since 2.9.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1251,6 +1268,7 @@ function upgrade_290() {
/** /**
* Execute changes made in WordPress 3.0. * Execute changes made in WordPress 3.0.
* *
* @ignore
* @since 3.0.0 * @since 3.0.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1296,6 +1314,7 @@ function upgrade_300() {
/** /**
* Execute changes made in WordPress 3.3. * Execute changes made in WordPress 3.3.
* *
* @ignore
* @since 3.3.0 * @since 3.3.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1370,6 +1389,7 @@ function upgrade_330() {
/** /**
* Execute changes made in WordPress 3.4. * Execute changes made in WordPress 3.4.
* *
* @ignore
* @since 3.4.0 * @since 3.4.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1406,6 +1426,7 @@ function upgrade_340() {
/** /**
* Execute changes made in WordPress 3.5. * Execute changes made in WordPress 3.5.
* *
* @ignore
* @since 3.5.0 * @since 3.5.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1436,6 +1457,7 @@ function upgrade_350() {
/** /**
* Execute changes made in WordPress 3.7. * Execute changes made in WordPress 3.7.
* *
* @ignore
* @since 3.7.0 * @since 3.7.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1449,6 +1471,7 @@ function upgrade_370() {
/** /**
* Execute changes made in WordPress 3.7.2. * Execute changes made in WordPress 3.7.2.
* *
* @ignore
* @since 3.7.2 * @since 3.7.2
* @since 3.8.0 * @since 3.8.0
* *
@ -1463,6 +1486,7 @@ function upgrade_372() {
/** /**
* Execute changes made in WordPress 3.8.0. * Execute changes made in WordPress 3.8.0.
* *
* @ignore
* @since 3.8.0 * @since 3.8.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1477,6 +1501,7 @@ function upgrade_380() {
/** /**
* Execute changes made in WordPress 4.0.0. * Execute changes made in WordPress 4.0.0.
* *
* @ignore
* @since 4.0.0 * @since 4.0.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1497,6 +1522,7 @@ function upgrade_400() {
/** /**
* Execute changes made in WordPress 4.2.0. * Execute changes made in WordPress 4.2.0.
* *
* @ignore
* @since 4.2.0 * @since 4.2.0
* *
* @global int $wp_current_db_version * @global int $wp_current_db_version
@ -1507,6 +1533,7 @@ function upgrade_420() {}
/** /**
* Executes changes made in WordPress 4.3.0. * Executes changes made in WordPress 4.3.0.
* *
* @ignore
* @since 4.3.0 * @since 4.3.0
* *
* @global int $wp_current_db_version Current version. * @global int $wp_current_db_version Current version.
@ -1545,6 +1572,7 @@ function upgrade_430() {
/** /**
* Executes comments changes made in WordPress 4.3.0. * Executes comments changes made in WordPress 4.3.0.
* *
* @ignore
* @since 4.3.0 * @since 4.3.0
* *
* @global int $wp_current_db_version Current version. * @global int $wp_current_db_version Current version.
@ -1594,6 +1622,7 @@ function upgrade_430_fix_comments() {
/** /**
* Executes changes made in WordPress 4.3.1. * Executes changes made in WordPress 4.3.1.
* *
* @ignore
* @since 4.3.1 * @since 4.3.1
*/ */
function upgrade_431() { function upgrade_431() {
@ -1608,6 +1637,7 @@ function upgrade_431() {
/** /**
* Executes changes made in WordPress 4.4.0. * Executes changes made in WordPress 4.4.0.
* *
* @ignore
* @since 4.4.0 * @since 4.4.0
* *
* @global int $wp_current_db_version Current version. * @global int $wp_current_db_version Current version.

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-35965'; $wp_version = '4.5-alpha-35966';
/** /**
* 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.