docs: update docblocks

This commit is contained in:
Ben Goldsworthy 2021-04-29 20:57:30 +01:00
parent 418abc253b
commit bfeb11d5ad
11 changed files with 363 additions and 306 deletions

View file

@ -1,37 +1,37 @@
<?php // phpcs:disable PEAR.NamingConventions.ValidClassName.Invalid
/**
* Define the internationalization functionality
* File providing core `Footnotes_i18n` class.
*
* Loads and defines the internationalization files for this plugin
* so that it is ready for translation.
* @package footnotes
* @subpackage includes
*
* @since 1.5.0
* @since 2.8.0 Renamed class to `Footnotes_i18n`.
*
* @package footnotes
* @subpackage includes
* @since 1.5.0
* @since 2.8.0 Rename file from `language.php` to `class-footnotes-i18n.php`.
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-footnotes-config.php';
/**
* Define the internationalization functionality.
* Class providing internationalization functionality.
*
* Loads and defines the internationalization files for this plugin
* so that it is ready for translation.
* Loads and defines the internationalization files for this plugin so that it
* is ready for translation.
*
* @since 1.5.0
* @since 2.8.0 Renamed class to `Footnotes_i18n`.
* @package footnotes
* @subpackage includes
* @link https://translate.wordpress.org/projects/wp-plugins/footnotes/ GlotPress listing
*
* @package footnotes
* @subpackage includes
*
* @since 1.5.0
* @since 2.8.0 Rename class from `Footnotes_Language` to `Footnotes_i18n`.
*/
class Footnotes_i18n {
/**
* Load the plugin text domain for translation.
*
* @since 1.5.1
* @since 2.8.0 Rename from `load()` to `load_plugin_textdomain()`. Remove unused `$p_str_language_code` parameter.
* @since 1.5.1
* @since 2.8.0 Rename from `load()` to `load_plugin_textdomain()`. Remove unused `$p_str_language_code` parameter.
*/
public function load_plugin_textdomain() {
load_plugin_textdomain(