WordPress-Plugin-Boilerplate/plugin-name/trunk/uninstall.php

<?php

/**
 * Short Description (no period for file headers)
 *
 * Long Description.
 *
 * @link  URL
 * @since x.x.x (if available)
 *
 * @package    TODO
 */

// If uninstall not called from WordPress, then exit.
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
	exit;
}
checking in the start of the docblocks for the various PHP files of the boilerplate Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-09 23:22:44 +03:00			`<?php`
removing all of the @TODO references as per GaryJones notes, "You can't have tags come before the short / long description, otherwise the descriptions end up as part of a multiline tag." removing these @TODO's until the team decides whether or not to replace them with something clearer, or to discuss it to the documentation 2014-05-02 06:26:16 +03:00
checking in the start of the docblocks for the various PHP files of the boilerplate Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-09 23:22:44 +03:00			`/**`
updating the docblocks to the match the wpcs http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/ Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-26 02:00:08 +03:00			`* Short Description (no period for file headers)`
updating the code comments as per the handbook Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-11 17:36:47 +03:00			`*`
updating the docblocks to the match the wpcs http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/ Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-26 02:00:08 +03:00			`* Long Description.`
checking in the start of the docblocks for the various PHP files of the boilerplate Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-09 23:22:44 +03:00			`*`
updating the docblocks for proper use of `TODO` and `@TODO` 2014-05-01 05:06:19 +03:00			`* @link URL`
updating the docblocks to the match the wpcs http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/ Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-26 02:00:08 +03:00			`* @since x.x.x (if available)`
			`*`
updating the docblocks for proper use of `TODO` and `@TODO` 2014-05-01 05:06:19 +03:00			`* @package TODO`
checking in the start of the docblocks for the various PHP files of the boilerplate Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-09 23:22:44 +03:00			`*/`

			`// If uninstall not called from WordPress, then exit.`
			`if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {`
			`exit;`
adding a trailing whitespace to all of our defined files this helps with cleaner diffs. It's also on one of the PSRs, and it's one of the WPCS rules. (ht @garyjones for the reminder) Signed-off-by: Tom McFarlin <tom@tommcfarlin.com> 2014-04-26 01:39:31 +03:00			`}`