docs: update docblocks

This commit is contained in:
Ben Goldsworthy 2021-04-30 18:03:15 +01:00
parent bfeb11d5ad
commit 7ad975c389
16 changed files with 1168 additions and 1924 deletions

View file

@ -6,7 +6,8 @@
* @subpackage includes
*
* @since 1.5.0
* @since 2.8.0 Rename file from `config.php` to `class-footnotes-config.php`.
* @since 2.8.0 Rename file from `config.php` to `class-footnotes-config.php`,
* rename `class/` sub-directory to `includes/`.
* @todo Remove.
* @deprecated
*/
@ -16,6 +17,9 @@
*
* This class contains no methods of properties.
*
* @package footnotes
* @subpackage includes
*
* @since 1.5.0
* @todo Remove.
* @deprecated

View file

@ -6,12 +6,16 @@
* @subpackage includes
*
* @since 1.5.0
* @since 2.8.0 Rename file from `convert.php` to `class-footnotes-convert.php`.
* @since 2.8.0 Rename file from `convert.php` to `class-footnotes-convert.php`,
* rename `class/` sub-directory to `includes/`.
*/
/**
* Class providing variable type and value conversion functions.
*
* @package footnotes
* @subpackage includes
*
* @since 1.5.0
*/
class Footnotes_Convert {

View file

@ -6,7 +6,8 @@
* @subpackage includes
*
* @since 1.5.0
* @since 2.8.0 Rename file from `language.php` to `class-footnotes-i18n.php`.
* @since 2.8.0 Rename file from `language.php` to `class-footnotes-i18n.php`,
* rename `class/` sub-directory to `includes/`.
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-config.php';

View file

@ -2,7 +2,7 @@
/**
* File providing the `Footnotes_Loader` class.
*
* @package footnotes
* @package footnotes
* @subpackage includes
*
* @since 2.8.0

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,8 @@
*
* @since 1.5.0
* @since 2.2.6 Add support for custom templates in sibling folder.
* @since 2.8.0 Rename file from `templates.php` to `class-footnotes-templates.php`.
* @since 2.8.0 Rename file from `templates.php` to `class-footnotes-templates.php`,
* rename `class/` sub-directory to `includes/`.
*/
/**

View file

@ -9,7 +9,8 @@
* @subpackage includes
*
* @since 1.5.0
* @since 2.8.0 Rename file from `init.php` to `class-footnotes.php`.
* @since 2.8.0 Rename file from `wysiwyg.php` to `class-footnotes-wysiwyg.php`,
* rename `class/` sub-directory to `includes/`.
*/
/**