From d8206c992e51699ece25d8fb381a69d8fa7ed00e Mon Sep 17 00:00:00 2001 From: Jean-Christian Denis Date: Sun, 23 Apr 2023 13:51:30 +0200 Subject: [PATCH] cosmetic (doc) --- src/FrontendTemplate.php | 20 ++++++++++---------- src/My.php | 25 +++++++++++++++++-------- 2 files changed, 27 insertions(+), 18 deletions(-) diff --git a/src/FrontendTemplate.php b/src/FrontendTemplate.php index e8fdbd0..d90075b 100644 --- a/src/FrontendTemplate.php +++ b/src/FrontendTemplate.php @@ -26,12 +26,12 @@ use dcTemplate; class FrontendTemplate { /** - * Template condition to check if there is an expired date + * Template condition to check if there is an expired date. * - * @param ArrayObject $attr Block attributes - * @param string $content Block content + * @param ArrayObject $attr Block attributes + * @param string $content Block content * - * @return string + * @return string */ public static function EntryExpiredIf(ArrayObject $attr, string $content): string { @@ -53,11 +53,11 @@ class FrontendTemplate } /** - * Template for expired date + * Template for expired date. * - * @param ArrayObject $attr Value attributes + * @param ArrayObject $attr Value attributes * - * @return string + * @return string */ public static function EntryExpiredDate(ArrayObject $attr): string { @@ -79,11 +79,11 @@ class FrontendTemplate } /** - * Template for expired time + * Template for expired time. * - * @param ArrayObject $attr Value attributes + * @param ArrayObject $attr Value attributes * - * @return string + * @return string */ public static function EntryExpiredTime(ArrayObject $attr): string { diff --git a/src/My.php b/src/My.php index 8b60eb2..7ed1c51 100644 --- a/src/My.php +++ b/src/My.php @@ -16,13 +16,18 @@ namespace Dotclear\Plugin\postExpired; use dcCore; +/** + * Module definiton shortcut. + */ class My { /** @var string This plugin meta type */ public const META_TYPE = 'post_expired'; /** - * This module id + * This module id. + * + * @return string The module id */ public static function id(): string { @@ -30,7 +35,9 @@ class My } /** - * This module name + * This module name. + * + * @return string The module translated name */ public static function name(): string { @@ -38,13 +45,14 @@ class My } /** - * Encode Expired Date settings + * Encode Expired Date settings. * * This is saved into post_meta as meta_id value, * so this must be less than 255 caracters. * - * @param array $in Array of options - * @return string "Serialized" options + * @param array $in Array of options + * + * @return string "Serialized" options */ public static function encode(array $in): string { @@ -57,10 +65,11 @@ class My } /** - * Decode Expired Date settings + * Decode Expired Date settings. * - * @param string $in "Serialized" options - * @return array Array of options + * @param string $in "Serialized" options + * + * @return array Array of options */ public static function decode(string $in): array {