inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 11:53:53 +02:00
Code Issues Releases Wiki Activity

removing all of the @TODO references

Browse source 
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
This commit is contained in:
Tom McFarlin 2014-05-01 23:26:16 -04:00
parent 6271822cb1
commit 793797ae71
15 changed files with 3 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
plugin-name/trunk/admin/class-plugin-name-admin-loader.php
View file

@ -1,7 +1,6 @@
<?php <?php
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* @since x.x.x * @since x.x.x
@ -9,7 +8,6 @@
*/ */
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
@ -23,7 +21,6 @@
class Plugin_Name_Admin_Loader { class Plugin_Name_Admin_Loader {
/** /**
* @TODO
* Short description. (use period) * Short description. (use period)
* *
* Long description. * Long description.
@ -35,8 +32,6 @@ class Plugin_Name_Admin_Loader {
public function run( $plugin_name_admin ) { public function run( $plugin_name_admin ) {
/** /**
* @TODO
*
* This function is used to define the various hooks that are used in the * This function is used to define the various hooks that are used in the
* dashboard-specific side of the plugin. This is achieved via dependency injection * dashboard-specific side of the plugin. This is achieved via dependency injection
* by passing an instance of Plugin_Name_Admin into this class. * by passing an instance of Plugin_Name_Admin into this class.

4
plugin-name/trunk/admin/class-plugin-name-admin.php
View file

@ -1,7 +1,6 @@
<?php <?php
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* @since x.x.x * @since x.x.x
@ -9,7 +8,6 @@
*/ */
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
@ -23,7 +21,6 @@
class Plugin_Name_Admin { class Plugin_Name_Admin {
/** /**
* @TODO
* Short description. (use period) * Short description. (use period)
* *
* Long description. * Long description.
@ -49,7 +46,6 @@ class Plugin_Name_Admin {
} }
/** /**
* @TODO
* Short description. (use period) * Short description. (use period)
* *
* Long description. * Long description.

2
plugin-name/trunk/admin/css/plugin-name-admin.css
View file

@ -1,6 +1,4 @@
/** /**
* @TODO
*
* All of the CSS for your Dashboard-specific functionality should be * All of the CSS for your Dashboard-specific functionality should be
* included in this file. * included in this file.
*/ */

2
plugin-name/trunk/admin/js/plugin-name-admin.js
View file

@ -2,8 +2,6 @@
'use strict'; 'use strict';
/** /**
* @TODO
*
* All of the code for your Dashboard-specific JavaScript source * All of the code for your Dashboard-specific JavaScript source
* should reside in this file. * should reside in this file.
* *

3
plugin-name/trunk/admin/partials/plugin-name-admin-display.php
View file

@ -1,6 +1,6 @@
<?php <?php
/** /**
* @TODO
* Define a short description for what this file does. * Define a short description for what this file does.
* *
* @since x.x.x * @since x.x.x
@ -8,7 +8,6 @@
*/ */
/** /**
* @TODO
* Define a short description for what this file does. * Define a short description for what this file does.
* *
* Define a longer description for the purpose of this file. * Define a longer description for the purpose of this file.

3
plugin-name/trunk/includes/class-plugin-name-activator.php
View file

@ -1,7 +1,6 @@
<?php <?php
/** /**
* @TODO
* Short description (no period for file headers) * Short description (no period for file headers)
* *
* Long description. * Long description.
@ -11,7 +10,6 @@
*/ */
/** /**
* @TODO
* Short description (no period for file headers) * Short description (no period for file headers)
* *
* Long description. * Long description.
@ -25,7 +23,6 @@
class Plugin_Name_Activator { class Plugin_Name_Activator {
/** /**
* @TODO
* Short description. (use period) * Short description. (use period)
* *
* Long description. * Long description.

3
plugin-name/trunk/includes/class-plugin-name-deactivator.php
View file

@ -1,7 +1,6 @@
<?php <?php
/** /**
* @TODO
* Short description (no period for file headers) * Short description (no period for file headers)
* *
* Long description. * Long description.
@ -11,7 +10,6 @@
*/ */
/** /**
* @TODO
* Short description (no period for file headers) * Short description (no period for file headers)
* *
* Long description. * Long description.
@ -25,7 +23,6 @@
class Plugin_Name_Deactivator { class Plugin_Name_Deactivator {
/** /**
* @TODO
* Short description. (use period) * Short description. (use period)
* *
* Long description. * Long description.

2
plugin-name/trunk/includes/class-plugin-name.php
View file

@ -1,7 +1,6 @@
<?php <?php
/** /**
* @TODO
* Short description (no period for file headers) * Short description (no period for file headers)
* *
* Long description. * Long description.
@ -11,7 +10,6 @@
*/ */
/** /**
* @TODO
* Short description (no period for file headers) * Short description (no period for file headers)
* *
* Long description. * Long description.

2
plugin-name/trunk/plugin-name.php
View file

@ -1,8 +1,6 @@
<?php <?php
/** /**
* @TODO
*
* Short Description (no period for file headers) * Short Description (no period for file headers)
* *
* Long Description. * Long Description.

5
plugin-name/trunk/public/class-plugin-name-public-loader.php
View file

@ -1,7 +1,6 @@
<?php <?php
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* @since x.x.x * @since x.x.x
@ -9,7 +8,6 @@
*/ */
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
@ -23,7 +21,6 @@
class Plugin_Name_Public_Loader { class Plugin_Name_Public_Loader {
/** /**
* @TODO
* Short description. (use period) * Short description. (use period)
* *
* Long description. * Long description.
@ -35,8 +32,6 @@ class Plugin_Name_Public_Loader {
public function run( $plugin_name_public ) { public function run( $plugin_name_public ) {
/** /**
* @TODO
*
* This function is used to define the various hooks that are used in the * This function is used to define the various hooks that are used in the
* public-facing side of the plugin. This is achieved via dependency injection * public-facing side of the plugin. This is achieved via dependency injection
* by passing an instance of Plugin_Name_Public into this class. * by passing an instance of Plugin_Name_Public into this class.

3
plugin-name/trunk/public/class-plugin-name-public.php
View file

@ -1,7 +1,6 @@
<?php <?php
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* @since x.x.x * @since x.x.x
@ -9,7 +8,6 @@
*/ */
/** /**
* @TODO
* Define a short description for what this class does. * Define a short description for what this class does.
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
@ -23,7 +21,6 @@
class Plugin_Name_Public { class Plugin_Name_Public {
/** /**
* @TODO
* Short description. (use period) * Short description. (use period)
* *
* Long description. * Long description.

2
plugin-name/trunk/public/css/plugin-name-public.css
View file

@ -1,6 +1,4 @@
/** /**
* @TODO
*
* All of the CSS for your public-facing functionality should be * All of the CSS for your public-facing functionality should be
* included in this file. * included in this file.
*/ */

2
plugin-name/trunk/public/js/plugin-name-public.js
View file

@ -2,8 +2,6 @@
'use strict'; 'use strict';
/** /**
* @TODO
*
* All of the code for your public-facing JavaScript source * All of the code for your public-facing JavaScript source
* should reside in this file. * should reside in this file.
* *

3
plugin-name/trunk/public/partials/plugin-name-public-display.php
View file

@ -1,6 +1,6 @@
<?php <?php
/** /**
* @TODO
* Define a short description for what this file does. * Define a short description for what this file does.
* *
* @since x.x.x * @since x.x.x
@ -8,7 +8,6 @@
*/ */
/** /**
* @TODO
* Define a short description for what this file does. * Define a short description for what this file does.
* *
* Define a longer description for the purpose of this file. * Define a longer description for the purpose of this file.

2
plugin-name/trunk/uninstall.php
View file

@ -1,6 +1,6 @@
<?php <?php
/** /**
* @TODO
* Short Description (no period for file headers) * Short Description (no period for file headers)
* *
* Long Description. * Long Description.