diff --git a/plugin-name/trunk/admin/class-plugin-name-admin.php b/plugin-name/trunk/admin/class-plugin-name-admin.php index 15933c0..9e66dd2 100644 --- a/plugin-name/trunk/admin/class-plugin-name-admin.php +++ b/plugin-name/trunk/admin/class-plugin-name-admin.php @@ -23,8 +23,22 @@ */ class Plugin_Name_Admin { + /** + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. + */ private $version; + /** + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. + */ public function __construct( $version ) { $this->version = $version; } diff --git a/plugin-name/trunk/includes/class-plugin-name-i18n.php b/plugin-name/trunk/includes/class-plugin-name-i18n.php index 0368a6b..4f06d72 100644 --- a/plugin-name/trunk/includes/class-plugin-name-i18n.php +++ b/plugin-name/trunk/includes/class-plugin-name-i18n.php @@ -23,6 +23,13 @@ */ class Plugin_Name_i18n { + /** + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $domain Description. + */ private $domain; /** @@ -41,7 +48,12 @@ class Plugin_Name_i18n { } /** - * TODO + * Short description. (use period) + * + * Long description. + * + * @since 1.0.0 + * @param float $domain TODO */ public function set_domain( $domain ) { $this->domain = $domain; diff --git a/plugin-name/trunk/includes/class-plugin-name-loader.php b/plugin-name/trunk/includes/class-plugin-name-loader.php index 9baceac..31b45a8 100644 --- a/plugin-name/trunk/includes/class-plugin-name-loader.php +++ b/plugin-name/trunk/includes/class-plugin-name-loader.php @@ -24,17 +24,28 @@ class Plugin_Name_Loader { /** - * TODO + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. */ protected $actions; /** - * TODO + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. */ protected $filters; /** - * TODO + * Short description. (use period) + * + * @since 1.0.0 + * @access private */ public function __construct() { @@ -44,21 +55,43 @@ class Plugin_Name_Loader { } /** - * TODO + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. + * @var type $var Description. + * @var type $var Description. + * @var type Optional $var Description. */ public function add_action( $hook, $component, $callback, $priority = 10 ) { $this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority ); } /** - * TODO + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. + * @var type $var Description. + * @var type $var Description. + * @var type Optional $var Description. */ public function add_filter( $hook, $component, $callback, $priority = 10 ) { $this->filters = $this->add( $this->filters, $hook, $component, $callback $priority ); } /** - * TODO + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. + * @var type $var Description. + * @var type $var Description. + * @var type $var Description. + * @var type Optional $var Description. */ private function add( $hooks, $hook, $component, $callback, $priority ) { @@ -83,12 +116,11 @@ class Plugin_Name_Loader { public function run() { /** + * TODO: * This function is used to define the various hooks that are shared in the * both the dashboard and the public-facing areas of the plugin. This is * achieved via dependency injection by passing an instance of Plugin_Name * into this class. - * - * TODO */ foreach ( $this->filters as $hook ) { diff --git a/plugin-name/trunk/includes/class-plugin-name.php b/plugin-name/trunk/includes/class-plugin-name.php index e8de47d..8b50eef 100644 --- a/plugin-name/trunk/includes/class-plugin-name.php +++ b/plugin-name/trunk/includes/class-plugin-name.php @@ -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; diff --git a/plugin-name/trunk/plugin-name.php b/plugin-name/trunk/plugin-name.php index 9ca4480..64fb86f 100644 --- a/plugin-name/trunk/plugin-name.php +++ b/plugin-name/trunk/plugin-name.php @@ -52,7 +52,11 @@ register_activation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactivat require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php'; /** - * TODO + * Short description. (use period) + * + * Long description. + * + * @since 1.0.0 */ function run_plugin_name() { diff --git a/plugin-name/trunk/public/class-plugin-name-public.php b/plugin-name/trunk/public/class-plugin-name-public.php index eb10ff0..a348b2c 100644 --- a/plugin-name/trunk/public/class-plugin-name-public.php +++ b/plugin-name/trunk/public/class-plugin-name-public.php @@ -23,8 +23,23 @@ */ class Plugin_Name_Public { + /** + * Short description. (use period) + * + * @since 1.0.0 + * @access private + * @var type $var Description. + */ private $version; + /** + * Short description. (use period) + * + * Long description. + * + * @since 1.0.0 + * @param float $version TODO + */ public function __construct( $version ) { $this->version = $version; }