docs: update docblocks
This commit is contained in:
parent
332f4b8284
commit
100a815cd5
11 changed files with 64 additions and 67 deletions
|
@ -59,15 +59,21 @@ class Footnotes_Admin {
|
|||
* Include the following files that provide the admin-specific functionality
|
||||
* of this plugin:
|
||||
*
|
||||
* - `Footnotes_WYSIWYG`. TODO
|
||||
* - `Footnotes_Layout_Settings`. TODO
|
||||
* - `Footnotes_WYSIWYG`. Provides plugin integration with the WYSIWYG editor.
|
||||
* - `Footnotes_Layout_Settings`. Defines the plugin dashboard page(s).
|
||||
*
|
||||
* @since 2.8.0
|
||||
* @access private
|
||||
*/
|
||||
private function load_dependencies() {
|
||||
// TODO: neaten up and document once placements and names are settled.
|
||||
/**
|
||||
* The class responsible for WYSIWYG editor integration.
|
||||
*/
|
||||
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'admin/class-footnotes-wysiwyg.php';
|
||||
|
||||
/**
|
||||
* The class responsible for constructing the plugin dashboard page(s).
|
||||
*/
|
||||
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'admin/layout/class-footnotes-layout-init.php';
|
||||
|
||||
new Footnotes_Layout_Init();
|
||||
|
|
|
@ -2,9 +2,10 @@
|
|||
/**
|
||||
* Includes the Plugin settings menu.
|
||||
*
|
||||
* @filesource
|
||||
* @package footnotes
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @package footnotes
|
||||
* @subpackage footnotes/admin
|
||||
*/
|
||||
|
||||
require_once dirname( __FILE__, 3 ) . '/includes/class-footnotes-settings.php';
|
||||
|
|
|
@ -2,10 +2,7 @@
|
|||
/**
|
||||
* Includes the Plugin Class to display all Settings.
|
||||
*
|
||||
* @filesource
|
||||
* @package footnotes
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @since 2.0.4 restore arrow settings
|
||||
* @since 2.1.0 read-on button label
|
||||
* @since 2.1.1 options for ref container and alternative tooltips
|
||||
|
@ -39,6 +36,9 @@
|
|||
* @since 2.4.0 footnote shortcode syntax validation
|
||||
* @since 2.5.0 Shortcode syntax validation: add more information around the setting, thanks to @andreasra
|
||||
* @link https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/
|
||||
*
|
||||
* @package footnotes
|
||||
* @subpackage footnotes/admin/layout
|
||||
*/
|
||||
|
||||
require_once dirname( __FILE__ ) . '/class-footnotes-layout-engine.php';
|
||||
|
|
Reference in a new issue