inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2025-04-19 05:35:36 +03:00
Code Issues Releases Wiki Activity

Documenting classes

Browse source 
Documenting classes that are core to each plugin, while also leaving other classes undocumented for an implementation-specific basis.
This commit is contained in:
Tom McFarlin 2014-07-29 16:56:18 -04:00
parent f09ca373d8
commit 560e5959a5
6 changed files with 137 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -24,30 +24,27 @@
class Plugin_Name_Public {
/**
* Short description. (use period)
* The version of this plugin.
*
* @since 1.0.0
* @access private
* @var type $var Description.
* @var string $version The current version of this plugin.
*/
private $version;
/**
* Short description. (use period)
*
* Long description.
* Initialize the class and set its properties.
*
* @since 1.0.0
* @param float $version TODO
* @access public
* @var string $version The version of this plugin.
*/
public function __construct( $version ) {
$this->version = $version;
}
/**
* Short description. (use period)
*
* Long description.
* Register the stylesheets for the public-facing side of the site.
*
* @since 1.0.0
*/
@ -70,9 +67,7 @@ class Plugin_Name_Public {
}
/**
* Short description. (use period)
*
* Long description.
* Register the stylesheets for the public-facing side of the site.
*
* @since 1.0.0
*/