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

finalizing page-level documentation to all php files

Browse source 
Fixes #46
This commit is contained in:
Tom McFarlin 2013-05-12 09:18:27 -04:00
parent a6366a7597
commit 68c8d4e3dc
2 changed files with 5 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
plugin-boilerplate/class-plugin-boilerplate.php
View file

@ -5,6 +5,9 @@
* A foundation off of which to build well-documented WordPress plugins that also follow * A foundation off of which to build well-documented WordPress plugins that also follow
* WordPress coding standards and PHP best practices. * WordPress coding standards and PHP best practices.
* *
* Use PHPDoc tags if you wish to be able to document the code using a documentation
* generator.
*
* @package PluginName * @package PluginName
* @author Your Name <email@example.com> * @author Your Name <email@example.com>
* @license GPL-2.0+ * @license GPL-2.0+
@ -38,18 +41,7 @@ if ( ! defined( 'PLUGIN_NAME_VERSION' ) ) {
} }
/** // TODO: Rename this class to a proper name for your plugin.
* TODO:
*
* Rename this class to a proper name for your plugin. Give a proper description of
* the plugin, it's purpose, and any dependencies it has.
*
* Use PHPDoc tags if you wish to be able to document the code using a documentation
* generator.
*
* @package PluginName
* @version 1.0.0
*/
class PluginName { class PluginName {
/** /**

2
plugin-boilerplate/plugin-boilerplate.php
View file

@ -37,5 +37,5 @@ if ( ! defined( 'ABSPATH' ) ) {
require_once( plugin_dir_path( __FILE__ ) . 'class-plugin-boilerplate.php' ); require_once( plugin_dir_path( __FILE__ ) . 'class-plugin-boilerplate.php' );
// TODO: make sure to replace PluginName with the name of the plugin defined in `class-plugin-boilerplate.php` // TODO: replace PluginName with the name of the plugin defined in `class-plugin-boilerplate.php`
PluginName::get_instance(); PluginName::get_instance();