Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update docblocks

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

71
src/includes/class-footnotes-config.php
View file

@ -1,65 +1,84 @@
<?php
/**
* Includes the Plugin Constants class to load all Plugin constant vars like Plugin name, etc.
* File providing the `Footnotes_Config` class.
*
* @since 1.5.0
* @since 2.0.4 add Public Plugin name for dashboard heading
* @package footnotes
* @subpackage includes
*
* @package footnotes
* @subpackage includes
* @since 1.5.0
* @since 2.8.0 Rename file from `config.php` to `class-footnotes-config.php`.
* @todo Remove.
* @deprecated
*/
/**
* Contains all Plugin Constants. Contains no Method or Property.
* Class defining plugin constants.
*
* @since 1.5.0
* This class contains no methods of properties.
*
* @since 1.5.0
* @todo Remove.
* @deprecated
*/
class Footnotes_Config {
/**
* Public Plugin name.
* Public plugin name.
*
* @since 1.5.0
* @var string
*
* edited classes for v2.0.4
* @since 1.5.0
* @todo Remove.
* @deprecated
*/
const C_STR_PLUGIN_PUBLIC_NAME = '<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>';
/**
* Public Plugin name for dashboard heading
* Public plugin name for use as a dashboard heading.
*
* After properly displaying in dashboard headings until WPv5.4, the above started
* in WPv5.5 being torn apart as if the headline was text-align:justify and not
* the last line. That ugly display bug badly affected the plugin’s communication.
* The only working solution found so far is using position:fixed in one heading
* that isn’t translated, and dropping the logo in another, translatable heading.
* in WP 5.5 being torn apart as if the headline was `text-align:justify` and not
* the last line. That ugly display bug badly affected the plugin's communication.
* The only working solution found so far is using `position:fixed` in one heading
* that isn't translated, and dropping the logo in another, translatable heading.
*
* @since 2.0.4
* @var string
* @var string
*
* @since 2.0.4
* @todo Remove.
* @deprecated
*/
const C_STR_PLUGIN_HEADING_NAME = '<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>';
/**
* Html tag for the LOVE symbol.
* HTML element for the ‘love’ symbol.
*
* @since 1.5.0
* @var string
* @var string
*
* @since 1.5.0
* @todo Remove.
* @deprecated
*/
const C_STR_LOVE_SYMBOL = '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>';
/**
* HTML code for the 'love' symbol used in dashboard heading
* HTML element for the ‘love’ symbol used in dashboard heading
*
* @since 2.0.4
* @var string
* @var string
*
* @since 2.0.4
* @todo Remove.
* @deprecated
*/
const C_STR_LOVE_SYMBOL_HEADING = '<span class="footnotes_heart_heading">&hearts;</span>';
/**
* Short code to DON'T display the 'LOVE ME' slug on certain pages.
* Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.
*
* @since 1.5.0
* @var string
* @var string
*
* @since 1.5.0
* @todo Remove.
* @deprecated
*/
const C_STR_NO_LOVE_SLUG = '[[no footnotes: love]]';
}