From 68c8d4e3dc103b26779e1d2e94ebc2831994f9ac Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Sun, 12 May 2013 09:18:27 -0400 Subject: [PATCH] finalizing page-level documentation to all php files Fixes #46 --- plugin-boilerplate/class-plugin-boilerplate.php | 16 ++++------------ plugin-boilerplate/plugin-boilerplate.php | 2 +- 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/plugin-boilerplate/class-plugin-boilerplate.php b/plugin-boilerplate/class-plugin-boilerplate.php index 7fa109c..8d2d143 100644 --- a/plugin-boilerplate/class-plugin-boilerplate.php +++ b/plugin-boilerplate/class-plugin-boilerplate.php @@ -5,6 +5,9 @@ * A foundation off of which to build well-documented WordPress plugins that also follow * 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 * @author Your Name * @license GPL-2.0+ @@ -38,18 +41,7 @@ if ( ! defined( 'PLUGIN_NAME_VERSION' ) ) { } -/** - * 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 - */ +// TODO: Rename this class to a proper name for your plugin. class PluginName { /** diff --git a/plugin-boilerplate/plugin-boilerplate.php b/plugin-boilerplate/plugin-boilerplate.php index 006de47..4e1c117 100644 --- a/plugin-boilerplate/plugin-boilerplate.php +++ b/plugin-boilerplate/plugin-boilerplate.php @@ -37,5 +37,5 @@ if ( ! defined( 'ABSPATH' ) ) { 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(); \ No newline at end of file