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

completing the initial round of PHP documentation as per the WPCS

Browse source 
http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#1-functions-and-class-methods
This commit is contained in:
Tom McFarlin 2014-06-26 16:19:57 -04:00
parent 9f5ffbf597
commit 23235f94d7
6 changed files with 152 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

77
plugin-name/trunk/includes/class-plugin-name.php
View file

@ -24,22 +24,36 @@
class Plugin_Name {
/**
* TODO
* Short description. (use period)
*
* @since 1.0.0
* @access protected
* @var type $var Description.
*/
protected $loader;
/**
* TODO
* Short description. (use period)
*
* @since 1.0.0
* @access protected
* @var type $var Description.
*/
protected $plugin_slug;
/**
* TODO
* Short description. (use period)
*
* @since 1.0.0
* @access protected
* @var type $var Description.
*/
protected $version;
/**
* TODO
* Short description. (use period)
*
* @since 1.0.0
*/
public function __construct() {
@ -54,7 +68,12 @@ class Plugin_Name {
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
* @access (for functions: only use if private)
*/
private function load_dependencies() {
@ -86,7 +105,12 @@ class Plugin_Name {
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
* @access (for functions: only use if private)
*/
private function set_locale() {
@ -97,7 +121,12 @@ class Plugin_Name {
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
* @access (for functions: only use if private)
*/
private function define_admin_hooks() {
@ -108,7 +137,12 @@ class Plugin_Name {
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
* @access (for functions: only use if private)
*/
private function define_public_hooks() {
@ -119,28 +153,47 @@ class Plugin_Name {
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
*/
public function run() {
$this->loader->run();
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
* @return type Description
*/
public function get_slug() {
return $this->plugin_slug;
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
* @return type Description
*/
public function get_loader() {
return $this->loader;
}
/**
* TODO
* Short description. (use period)
*
* Long description.
*
* @since 1.0.0
* @return type Description
*/
public function get_version() {
return $this->version;