1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-11-05 05:12:57 +02:00
Commit graph

20 commits

Author SHA1 Message Date
Tom McFarlin aea004af54 Chaing the doc from 'slug' to 'string' 2014-08-01 16:59:19 -04:00
Tom McFarlin f3133d8cb5 Improving docblocks
* Documenting the plugin file
* Changing the docblock to read 'class', not 'file'

Related #199
2014-08-01 16:47:08 -04:00
Tom McFarlin 43ee54a0ee Adding documentation to two missing functions
Fixes #192
2014-07-30 15:03:33 -04:00
Tom McFarlin ec29ebc95b Renaming the plugin slug to the plugin name
Also renaming the text domain in the header of the core plugin file to match that of the plugin name

Fixes #194
2014-07-30 13:58:41 -04:00
Tom McFarlin 81b3c8bd6d Updating the arguments passed to the classes 2014-07-29 17:10:31 -04:00
Tom McFarlin 560e5959a5 Documenting classes
Documenting classes that are core to each plugin, while also leaving other classes undocumented for an implementation-specific basis.
2014-07-29 16:56:18 -04:00
Tom McFarlin b706dc3291 Updating code comments
Making sure that the code comments strictly follow that of the WordPress PHP Documentation Standards
2014-07-29 16:03:09 -04:00
Tom McFarlin 23235f94d7 completing the initial round of PHP documentation as per the WPCS
http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#1-functions-and-class-methods
2014-06-26 16:19:57 -04:00
Tom McFarlin f332130569 moving all bootstrap code into this file, adding some getters for dependencies
setting up this file to fire the plugin so that it's prepared to handle any hooks given to the loader
2014-05-08 23:34:16 -04:00
Tom McFarlin 0d63ec21e5 adding getters for the protected properties 2014-05-08 18:10:04 -04:00
Tom McFarlin 00c5f7d733 adding a public getter for the plugin slug so that external classes can reference it
ht @garyjoes b5549d5f9c (commitcomment-6236733)
2014-05-08 16:50:23 -04:00
Tom McFarlin b5549d5f9c defining a base class from which all other components can inherit
also getting rid of the version constant in place of a properly, defining a single entry point with the run function, and defining the plugin slug as a property
2014-05-05 00:18:04 -04:00
Tom McFarlin c83aa5434d updating the docblocks 2014-05-03 15:28:04 -04:00
Tom McFarlin 4114ad703e updating the docblocks 2014-05-03 15:07:05 -04:00
Tom McFarlin 793797ae71 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-01 23:26:16 -04:00
Tom McFarlin 0896f0836c defining the core shared plugin name
this file is used to be shared between the dashboard and public-facing functionality. it's hooks should be defined in the specific loader
2014-04-30 22:55:34 -04:00
Tom McFarlin 026515da85 adding docblocks consistent with the wpcs for the files in includes
http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-25 18:58:07 -04:00
Tom McFarlin 2cf4ba8223 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-25 18:39:31 -04:00
Tom McFarlin 28da2f7c41 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 16:22:44 -04:00
Tom McFarlin 83f6ea69c6 initial commit
initial commit of the skeleton structure of the wordpress plugin boilerplate

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-03-18 21:53:57 -04:00