From 1a616eeb659906c8fae678778ecfd5f0051a157a Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Tue, 7 May 2013 22:42:30 -0400 Subject: [PATCH] improving documentation --- plugin-boilerplate/plugin.php | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/plugin-boilerplate/plugin.php b/plugin-boilerplate/plugin.php index 67da291..6844614 100644 --- a/plugin-boilerplate/plugin.php +++ b/plugin-boilerplate/plugin.php @@ -26,7 +26,17 @@ License: */ -// 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 directives if you wish to be able to document the code using a documentation + * generator. + * + * @version 1.0 + */ class PluginName { /*--------------------------------------------*