DocBlocks collection for WP development

DocBlocks-for-WP.php

<?php
/**
 * DocBlocks for WordPress
 * 
 * Structural Elements:
 *	-- to be documented with DocBlocks --
 * 
 * class
 * function (including methods)
 * variable
 * const(ant)/define
 * 
 * require(_once)
 * include(_once)
 * interface
 * trait
 * namespace
 * property
 * 
 * ? module
 * 
 * 
 * FQSEN (Fully Qualified Structural Element Name):
 * 	-- examples: --
 * \My\Space\MyClass::myMethod()
 * somefunction()
 * MyClassName
 * \My\Namespace
 * CONSTANT
 * _CONSTANT
 * 
 * 
 * Types:
 * string
 * int(eger)
 * bool(ean)
 * float/double
 * object
 * mixed
 * array
 * resource
 * void
 * null
 * callable
 * self
 * 
 */

/**
 * Short description (required:*)
 * 
 * Long description
 * multi-line enabled (optional:*)
 * 
 * @todo [<description>] (optional:*)
 * @ignore [<description>] (optional:*) {Element is not to be processed}
 * @since [x.x.x] [<description>(optional:*)] (required:*) {Semantic Versioning 2.0.0 - www.semver.org}
 * @abstract (optional:class|function|var)
 * @final (optional:class|function|var)
 * @static (optional:class|function|var)
 * @access [public|private|protected] (required:class|function|var)
 * @var [Type] [name] [<description>] (required:var) {docs for first time introduced variables}
 * @global [Type] [[name]<description(optional)>] (optional:function)
 * 
 * @see [URI|FQSEN] [<description>(optional)] (optional:function) {WordPress core or plugin resource (includes constanst) outside the current package}
 * @uses [FQSEN] [<description>(optional)] (optional:function) {Plugin resource (includes constanst) within the package}
 * 
 * @action [WP_Action] [<description>(optional)] (optional:function) {(WordPress) action the function is hooked in to}
 * @filter [WP_Filter] [<description>(optional)] (optional:function) {(WordPress) filter the function is hooked in to}
 *
 * @param [Type] [name(required)] [<description>(optional)] (optional:function|method) {}
 * @return [Type|void] [[name]<description(optional)>(optional)] (required:function|method) {}
 */
 
/**
 * Class' short description (required)
 * 
 * Class' long description
 * multi-line enabled (optional)
 * 
 * @todo [<description>] (optional)
 * @ignore [<description>] (optional)
 * @abstract (optional)
 * @final (optional)
 * @since [x.x.x] [<description>(optional)] (required)
 */
 
/**
 * Function's short description	(required)
 * 
 * Function's long description
 * multi-line enabled 			(optional)
 * 
 * @todo [<description>]  (optional)
 * @ignore [<description>] (optional)
 * @since [x.x.x] [<description>(optional)] (required)
 * @abstract (optional)
 * @final (optional)
 * @since [x.x.x] [<description>(optional)] (required)
 * @access [public|private|protected] (required)
 * @global [Type] [[name]<description(optional)>] (optional)
 * 
 * @see [URI|FQSEN] [<description>(optional)] (optional)
 * @uses [FQSEN] [<description>(optional)] (optional)
 * 
 * @action [WP_Action] [<description>(optional)] (optional)
 * @filter [WP_Filter] [<description>(optional)] (optional)
 * @hook [action|filter] [hookname] [<description>(optional)] (optional)
 *
 * @param [Type] [name(required)] [<description>(optional)] (optional)
 * @return [Type|void] [[name]<description>(optional)] (required)
 */
 
/**
 * Variable's description (required)
 * 
 * Variable's long description
 * multi-line enabled (optional)
 * 
 * @todo [<description>] (optional)
 * @ignore [<description>] (optional)
 * @since [x.x.x] [<description>(optional)] (required)
 * @abstract (optional)
 * @static (optional)
 * @access [public|private|protected] (required)
 * @var [Type] [name] [<description>] (required)
 */
 
/**
 * Constant's short description (required)
 * 
 * Constant's long description
 * multi-line enabled (optional)
 * 
 * @todo [<description>] (optional)
 * @ignore [<description>] (optional)
 * @since [x.x.x] [<description>(optional)] (required)
 */