diff options
| author | Greg Roach <fisharebest@webtrees.net> | 2019-01-22 11:04:45 +0000 |
|---|---|---|
| committer | Greg Roach <fisharebest@webtrees.net> | 2019-01-22 11:04:45 +0000 |
| commit | 961ec7555e8fa1828ea16f2a1fd6a74f140ce707 (patch) | |
| tree | b26be57d24d257cec0743405542322318498ee30 /app | |
| parent | 5227b2029ea60eb92ec9219a6a8a7998ccaebdbc (diff) | |
| download | webtrees-961ec7555e8fa1828ea16f2a1fd6a74f140ce707.tar.gz webtrees-961ec7555e8fa1828ea16f2a1fd6a74f140ce707.tar.bz2 webtrees-961ec7555e8fa1828ea16f2a1fd6a74f140ce707.zip | |
PHPdoc
Diffstat (limited to 'app')
51 files changed, 505 insertions, 100 deletions
diff --git a/app/Individual.php b/app/Individual.php index bd073342d5..2db05374e0 100644 --- a/app/Individual.php +++ b/app/Individual.php @@ -1134,7 +1134,11 @@ class Individual extends GedcomRecord return $txt; } - /** {@inheritdoc} */ + /** + * If this object has no name, what do we call it? + * + * @return string + */ public function getFallBackName(): string { return '@P.N. /@N.N./'; diff --git a/app/Module/BirthReportModule.php b/app/Module/BirthReportModule.php index bb3ddf6364..7c7d96b9bd 100644 --- a/app/Module/BirthReportModule.php +++ b/app/Module/BirthReportModule.php @@ -28,7 +28,11 @@ class BirthReportModule extends AbstractModule implements ModuleInterface, Modul { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class BirthReportModule extends AbstractModule implements ModuleInterface, Modul return I18N::translate('Births'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/CalendarMenuModule.php b/app/Module/CalendarMenuModule.php index c163bc7a7f..84d60d9751 100644 --- a/app/Module/CalendarMenuModule.php +++ b/app/Module/CalendarMenuModule.php @@ -28,14 +28,22 @@ class CalendarMenuModule extends AbstractModule implements ModuleInterface, Modu { use ModuleMenuTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Calendar'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Reports” module */ diff --git a/app/Module/CemeteryReportModule.php b/app/Module/CemeteryReportModule.php index 8e69681c3f..6f58a3ce47 100644 --- a/app/Module/CemeteryReportModule.php +++ b/app/Module/CemeteryReportModule.php @@ -28,7 +28,11 @@ class CemeteryReportModule extends AbstractModule implements ModuleInterface, Mo { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class CemeteryReportModule extends AbstractModule implements ModuleInterface, Mo return I18N::translate('Burials'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/CensusAssistantModule.php b/app/Module/CensusAssistantModule.php index 78daf95aaf..b414fa436d 100644 --- a/app/Module/CensusAssistantModule.php +++ b/app/Module/CensusAssistantModule.php @@ -31,14 +31,22 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; */ class CensusAssistantModule extends AbstractModule implements ModuleInterface { - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Census assistant'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Census assistant” module */ diff --git a/app/Module/ChangeReportModule.php b/app/Module/ChangeReportModule.php index c7890eda48..e2fd5d9370 100644 --- a/app/Module/ChangeReportModule.php +++ b/app/Module/ChangeReportModule.php @@ -32,7 +32,11 @@ class ChangeReportModule extends AbstractModule implements ModuleInterface, Modu /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_USER; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -40,7 +44,11 @@ class ChangeReportModule extends AbstractModule implements ModuleInterface, Modu return I18N::translate('Changes'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/ChartsBlockModule.php b/app/Module/ChartsBlockModule.php index 2b58cdbba2..3bc02ea19f 100644 --- a/app/Module/ChartsBlockModule.php +++ b/app/Module/ChartsBlockModule.php @@ -32,14 +32,22 @@ class ChartsBlockModule extends AbstractModule implements ModuleInterface, Modul { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module/block */ return I18N::translate('Charts'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Charts” module */ diff --git a/app/Module/ChartsMenuModule.php b/app/Module/ChartsMenuModule.php index 685fa14c8a..719c2e2df9 100644 --- a/app/Module/ChartsMenuModule.php +++ b/app/Module/ChartsMenuModule.php @@ -32,14 +32,22 @@ class ChartsMenuModule extends AbstractModule implements ModuleInterface, Module { use ModuleMenuTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Charts'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Reports” module */ diff --git a/app/Module/CkeditorModule.php b/app/Module/CkeditorModule.php index fe300bcd77..1c8181b8b3 100644 --- a/app/Module/CkeditorModule.php +++ b/app/Module/CkeditorModule.php @@ -27,14 +27,22 @@ class CkeditorModule extends AbstractModule implements ModuleInterface // Location of our installation of CK editor. public const CKEDITOR_PATH = 'public/ckeditor-4.5.2-custom/'; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module. CKEditor is a trademark. Do not translate it? http://ckeditor.com */ return I18N::translate('CKEditor™'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “CKEditor” module. WYSIWYG = “what you see is what you get” */ diff --git a/app/Module/ClippingsCartModule.php b/app/Module/ClippingsCartModule.php index 115aff5d5b..e18538a0c4 100644 --- a/app/Module/ClippingsCartModule.php +++ b/app/Module/ClippingsCartModule.php @@ -67,14 +67,22 @@ class ClippingsCartModule extends AbstractModule implements ModuleInterface, Mod /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_USER; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Clippings cart'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Clippings cart” module */ diff --git a/app/Module/DeathReportModule.php b/app/Module/DeathReportModule.php index 23f8701d88..7f234ed57f 100644 --- a/app/Module/DeathReportModule.php +++ b/app/Module/DeathReportModule.php @@ -28,7 +28,11 @@ class DeathReportModule extends AbstractModule implements ModuleInterface, Modul { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class DeathReportModule extends AbstractModule implements ModuleInterface, Modul return I18N::translate('Deaths'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/DescendancyModule.php b/app/Module/DescendancyModule.php index bc330dcff6..f37a54f804 100644 --- a/app/Module/DescendancyModule.php +++ b/app/Module/DescendancyModule.php @@ -33,14 +33,22 @@ class DescendancyModule extends AbstractModule implements ModuleInterface, Modul { use ModuleSidebarTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module/sidebar */ return I18N::translate('Descendants'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Descendants” module */ diff --git a/app/Module/DescendancyReportModule.php b/app/Module/DescendancyReportModule.php index b9b4eaf8a2..5350dac48b 100644 --- a/app/Module/DescendancyReportModule.php +++ b/app/Module/DescendancyReportModule.php @@ -28,7 +28,11 @@ class DescendancyReportModule extends AbstractModule implements ModuleInterface, { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class DescendancyReportModule extends AbstractModule implements ModuleInterface, return I18N::translate('Descendants'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/ExtraInformationModule.php b/app/Module/ExtraInformationModule.php index ffbdac02dc..b59108160c 100644 --- a/app/Module/ExtraInformationModule.php +++ b/app/Module/ExtraInformationModule.php @@ -30,14 +30,22 @@ class ExtraInformationModule extends AbstractModule implements ModuleInterface, { use ModuleSidebarTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module/sidebar */ return I18N::translate('Extra information'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Extra information” module */ diff --git a/app/Module/FactSourcesReportModule.php b/app/Module/FactSourcesReportModule.php index 969e3c3264..9e802783b4 100644 --- a/app/Module/FactSourcesReportModule.php +++ b/app/Module/FactSourcesReportModule.php @@ -32,7 +32,11 @@ class FactSourcesReportModule extends AbstractModule implements ModuleInterface, /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_USER; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -40,7 +44,11 @@ class FactSourcesReportModule extends AbstractModule implements ModuleInterface, return I18N::translate('Source'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/FamilyGroupReportModule.php b/app/Module/FamilyGroupReportModule.php index ccd492e117..86b7139033 100644 --- a/app/Module/FamilyGroupReportModule.php +++ b/app/Module/FamilyGroupReportModule.php @@ -28,7 +28,11 @@ class FamilyGroupReportModule extends AbstractModule implements ModuleInterface, { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class FamilyGroupReportModule extends AbstractModule implements ModuleInterface, return I18N::translate('Family'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/FamilyNavigatorModule.php b/app/Module/FamilyNavigatorModule.php index d56feb0dcc..0a8b5bf02e 100644 --- a/app/Module/FamilyNavigatorModule.php +++ b/app/Module/FamilyNavigatorModule.php @@ -27,14 +27,22 @@ class FamilyNavigatorModule extends AbstractModule implements ModuleInterface, M { use ModuleSidebarTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module/sidebar */ return I18N::translate('Family navigator'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Family navigator” module */ diff --git a/app/Module/FamilyTreeStatisticsModule.php b/app/Module/FamilyTreeStatisticsModule.php index f5350c453e..f1dd638f37 100644 --- a/app/Module/FamilyTreeStatisticsModule.php +++ b/app/Module/FamilyTreeStatisticsModule.php @@ -35,14 +35,22 @@ class FamilyTreeStatisticsModule extends AbstractModule implements ModuleInterfa /** Show this number of surnames by default */ private const DEFAULT_NUMBER_OF_SURNAMES = '10'; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Statistics'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of “Statistics” module */ diff --git a/app/Module/FrequentlyAskedQuestionsModule.php b/app/Module/FrequentlyAskedQuestionsModule.php index 4a8e51c8a4..8c7a99b41a 100644 --- a/app/Module/FrequentlyAskedQuestionsModule.php +++ b/app/Module/FrequentlyAskedQuestionsModule.php @@ -36,14 +36,22 @@ class FrequentlyAskedQuestionsModule extends AbstractModule implements ModuleInt use ModuleConfigTrait; use ModuleMenuTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module. Abbreviation for “Frequently Asked Questions” */ return I18N::translate('FAQ'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “FAQ” module */ diff --git a/app/Module/HtmlBlockModule.php b/app/Module/HtmlBlockModule.php index 62a8fd6eab..4784955235 100644 --- a/app/Module/HtmlBlockModule.php +++ b/app/Module/HtmlBlockModule.php @@ -31,14 +31,22 @@ class HtmlBlockModule extends AbstractModule implements ModuleInterface, ModuleB { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('HTML'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “HTML” module */ diff --git a/app/Module/IndividualFactsTabModule.php b/app/Module/IndividualFactsTabModule.php index 38a0c402fb..95056c5d0c 100644 --- a/app/Module/IndividualFactsTabModule.php +++ b/app/Module/IndividualFactsTabModule.php @@ -34,14 +34,22 @@ class IndividualFactsTabModule extends AbstractModule implements ModuleInterface { use ModuleTabTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module/tab on the individual page. */ return I18N::translate('Facts and events'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Facts and events” module */ diff --git a/app/Module/IndividualFamiliesReportModule.php b/app/Module/IndividualFamiliesReportModule.php index b7154720c1..ffc8447822 100644 --- a/app/Module/IndividualFamiliesReportModule.php +++ b/app/Module/IndividualFamiliesReportModule.php @@ -32,7 +32,11 @@ class IndividualFamiliesReportModule extends AbstractModule implements ModuleInt /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_USER; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -40,7 +44,11 @@ class IndividualFamiliesReportModule extends AbstractModule implements ModuleInt return I18N::translate('Related families'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/IndividualReportModule.php b/app/Module/IndividualReportModule.php index f9eaae8480..05e036e60e 100644 --- a/app/Module/IndividualReportModule.php +++ b/app/Module/IndividualReportModule.php @@ -28,7 +28,11 @@ class IndividualReportModule extends AbstractModule implements ModuleInterface, { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class IndividualReportModule extends AbstractModule implements ModuleInterface, return I18N::translate('Individual'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/InteractiveTreeModule.php b/app/Module/InteractiveTreeModule.php index 09cbaa55f7..b95d19fbe0 100644 --- a/app/Module/InteractiveTreeModule.php +++ b/app/Module/InteractiveTreeModule.php @@ -38,14 +38,22 @@ class InteractiveTreeModule extends AbstractModule implements ModuleInterface, M use ModuleChartTrait; use ModuleTabTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Interactive tree'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Interactive tree” module */ diff --git a/app/Module/ListsMenuModule.php b/app/Module/ListsMenuModule.php index 6ba8c1f1cb..e98e0a8441 100644 --- a/app/Module/ListsMenuModule.php +++ b/app/Module/ListsMenuModule.php @@ -29,14 +29,22 @@ class ListsMenuModule extends AbstractModule implements ModuleInterface, ModuleM { use ModuleMenuTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Lists'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Reports” module */ diff --git a/app/Module/LoggedInUsersModule.php b/app/Module/LoggedInUsersModule.php index 508514f4f6..582649d1c0 100644 --- a/app/Module/LoggedInUsersModule.php +++ b/app/Module/LoggedInUsersModule.php @@ -31,14 +31,22 @@ class LoggedInUsersModule extends AbstractModule implements ModuleInterface, Mod { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module. (A list of users who are online now) */ return I18N::translate('Who is online'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Who is online” module */ diff --git a/app/Module/LoginBlockModule.php b/app/Module/LoginBlockModule.php index 1919b9da52..7e51cf862d 100644 --- a/app/Module/LoginBlockModule.php +++ b/app/Module/LoginBlockModule.php @@ -30,14 +30,22 @@ class LoginBlockModule extends AbstractModule implements ModuleInterface, Module { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Sign in'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Sign in” module */ diff --git a/app/Module/MarriageReportModule.php b/app/Module/MarriageReportModule.php index 7e6ca928d6..69b6eb51f7 100644 --- a/app/Module/MarriageReportModule.php +++ b/app/Module/MarriageReportModule.php @@ -28,7 +28,11 @@ class MarriageReportModule extends AbstractModule implements ModuleInterface, Mo { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class MarriageReportModule extends AbstractModule implements ModuleInterface, Mo return I18N::translate('Marriages'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/MediaTabModule.php b/app/Module/MediaTabModule.php index 491f2654e0..28d3e71050 100644 --- a/app/Module/MediaTabModule.php +++ b/app/Module/MediaTabModule.php @@ -33,14 +33,22 @@ class MediaTabModule extends AbstractModule implements ModuleInterface, ModuleTa /** @var Fact[] A list of facts with media objects. */ private $facts; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Media'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Media” module */ diff --git a/app/Module/MissingFactsReportModule.php b/app/Module/MissingFactsReportModule.php index ca80bcabc9..e3b9411450 100644 --- a/app/Module/MissingFactsReportModule.php +++ b/app/Module/MissingFactsReportModule.php @@ -32,7 +32,11 @@ class MissingFactsReportModule extends AbstractModule implements ModuleInterface /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_USER; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -40,7 +44,11 @@ class MissingFactsReportModule extends AbstractModule implements ModuleInterface return I18N::translate('Missing data'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/NotesTabModule.php b/app/Module/NotesTabModule.php index 04f1a3c9a0..b71bead6c6 100644 --- a/app/Module/NotesTabModule.php +++ b/app/Module/NotesTabModule.php @@ -32,14 +32,22 @@ class NotesTabModule extends AbstractModule implements ModuleInterface, ModuleTa /** @var Fact[] A list facts for this note. */ private $facts; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Notes'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Notes” module */ diff --git a/app/Module/OccupationReportModule.php b/app/Module/OccupationReportModule.php index cd3f6b6031..15232678fc 100644 --- a/app/Module/OccupationReportModule.php +++ b/app/Module/OccupationReportModule.php @@ -32,7 +32,11 @@ class OccupationReportModule extends AbstractModule implements ModuleInterface, /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_USER; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -40,7 +44,11 @@ class OccupationReportModule extends AbstractModule implements ModuleInterface, return I18N::translate('Occupations'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/PedigreeMapModule.php b/app/Module/PedigreeMapModule.php index 0f32ea5194..f8127c4d0b 100644 --- a/app/Module/PedigreeMapModule.php +++ b/app/Module/PedigreeMapModule.php @@ -61,14 +61,22 @@ class PedigreeMapModule extends AbstractModule implements ModuleInterface, Modul private static $map_providers = null; private static $map_selections = null; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Pedigree map'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “OSM” module */ diff --git a/app/Module/PedigreeReportModule.php b/app/Module/PedigreeReportModule.php index 8d0d344b16..54bc472174 100644 --- a/app/Module/PedigreeReportModule.php +++ b/app/Module/PedigreeReportModule.php @@ -28,7 +28,11 @@ class PedigreeReportModule extends AbstractModule implements ModuleInterface, Mo { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class PedigreeReportModule extends AbstractModule implements ModuleInterface, Mo return I18N::translate('Pedigree'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/PlacesModule.php b/app/Module/PlacesModule.php index 68e24c264f..2e301ded5a 100644 --- a/app/Module/PlacesModule.php +++ b/app/Module/PlacesModule.php @@ -38,14 +38,22 @@ class PlacesModule extends AbstractModule implements ModuleInterface, ModuleTabI private static $map_providers = null; private static $map_selections = null; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Places'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “OSM” module */ diff --git a/app/Module/RecentChangesModule.php b/app/Module/RecentChangesModule.php index 5881efb57a..97a4e4c0b6 100644 --- a/app/Module/RecentChangesModule.php +++ b/app/Module/RecentChangesModule.php @@ -38,14 +38,22 @@ class RecentChangesModule extends AbstractModule implements ModuleInterface, Mod private const DEFAULT_INFO_STYLE = 'table'; private const MAX_DAYS = 90; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Recent changes'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Recent changes” module */ diff --git a/app/Module/RelatedIndividualsReportModule.php b/app/Module/RelatedIndividualsReportModule.php index 7d4febdc06..97b9feb12f 100644 --- a/app/Module/RelatedIndividualsReportModule.php +++ b/app/Module/RelatedIndividualsReportModule.php @@ -28,7 +28,11 @@ class RelatedIndividualsReportModule extends AbstractModule implements ModuleInt { use ModuleReportTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { // This text also appears in the .XML file - update both together @@ -36,7 +40,11 @@ class RelatedIndividualsReportModule extends AbstractModule implements ModuleInt return I18N::translate('Related individuals'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { // This text also appears in the .XML file - update both together diff --git a/app/Module/ReportsMenuModule.php b/app/Module/ReportsMenuModule.php index edd3f1125e..dfedacc5ea 100644 --- a/app/Module/ReportsMenuModule.php +++ b/app/Module/ReportsMenuModule.php @@ -32,6 +32,11 @@ class ReportsMenuModule extends AbstractModule implements ModuleInterface, Modul { use ModuleMenuTrait; + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ /** {@inheritdoc} */ public function title(): string { @@ -39,7 +44,11 @@ class ReportsMenuModule extends AbstractModule implements ModuleInterface, Modul return I18N::translate('Reports'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Reports” module */ diff --git a/app/Module/ResearchTaskModule.php b/app/Module/ResearchTaskModule.php index 570d84be9d..9aaa95e50b 100644 --- a/app/Module/ResearchTaskModule.php +++ b/app/Module/ResearchTaskModule.php @@ -39,14 +39,22 @@ class ResearchTaskModule extends AbstractModule implements ModuleInterface, Modu private const DEFAULT_SHOW_UNASSIGNED = '1'; private const DEFAULT_SHOW_FUTURE = '1'; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module. Tasks that need further research. */ return I18N::translate('Research tasks'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of “Research tasks” module */ diff --git a/app/Module/ReviewChangesModule.php b/app/Module/ReviewChangesModule.php index 3fb0d2726d..dd04c64902 100644 --- a/app/Module/ReviewChangesModule.php +++ b/app/Module/ReviewChangesModule.php @@ -35,14 +35,22 @@ class ReviewChangesModule extends AbstractModule implements ModuleInterface, Mod { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Pending changes'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Pending changes” module */ diff --git a/app/Module/SearchMenuModule.php b/app/Module/SearchMenuModule.php index 8f964af2b8..2ab8dd3106 100644 --- a/app/Module/SearchMenuModule.php +++ b/app/Module/SearchMenuModule.php @@ -29,14 +29,22 @@ class SearchMenuModule extends AbstractModule implements ModuleInterface, Module { use ModuleMenuTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Search'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Reports” module */ diff --git a/app/Module/SlideShowModule.php b/app/Module/SlideShowModule.php index 70520f74a4..315ea36e7e 100644 --- a/app/Module/SlideShowModule.php +++ b/app/Module/SlideShowModule.php @@ -34,14 +34,22 @@ class SlideShowModule extends AbstractModule implements ModuleInterface, ModuleB { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Slide show'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Slide show” module */ diff --git a/app/Module/SourcesTabModule.php b/app/Module/SourcesTabModule.php index d2882ee98a..411613a03f 100644 --- a/app/Module/SourcesTabModule.php +++ b/app/Module/SourcesTabModule.php @@ -32,14 +32,22 @@ class SourcesTabModule extends AbstractModule implements ModuleInterface, Module /** @var Fact[] All facts belonging to this source. */ private $facts; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Sources'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Sources” module */ diff --git a/app/Module/StoriesModule.php b/app/Module/StoriesModule.php index 2e3e947620..76e8a3f1c4 100644 --- a/app/Module/StoriesModule.php +++ b/app/Module/StoriesModule.php @@ -40,14 +40,22 @@ class StoriesModule extends AbstractModule implements ModuleInterface, ModuleCon /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_HIDE; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Stories'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Stories” module */ diff --git a/app/Module/ThemeSelectModule.php b/app/Module/ThemeSelectModule.php index 8d89f0fab2..33592071c9 100644 --- a/app/Module/ThemeSelectModule.php +++ b/app/Module/ThemeSelectModule.php @@ -29,14 +29,22 @@ class ThemeSelectModule extends AbstractModule implements ModuleInterface, Modul { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Theme change'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Theme change” module */ diff --git a/app/Module/TopGivenNamesModule.php b/app/Module/TopGivenNamesModule.php index a00bb05952..cfe51ba5ed 100644 --- a/app/Module/TopGivenNamesModule.php +++ b/app/Module/TopGivenNamesModule.php @@ -34,14 +34,22 @@ class TopGivenNamesModule extends AbstractModule implements ModuleInterface, Mod private const DEFAULT_NUMBER = '10'; private const DEFAULT_STYLE = 'table'; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module. Top=Most common */ return I18N::translate('Top given names'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Top given names” module */ diff --git a/app/Module/TreesMenuModule.php b/app/Module/TreesMenuModule.php index 65710d5fb6..5398e17374 100644 --- a/app/Module/TreesMenuModule.php +++ b/app/Module/TreesMenuModule.php @@ -29,14 +29,22 @@ class TreesMenuModule extends AbstractModule implements ModuleInterface, ModuleM { use ModuleMenuTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Family trees'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Reports” module */ diff --git a/app/Module/UserMessagesModule.php b/app/Module/UserMessagesModule.php index 88dd4a566a..f37511f7a1 100644 --- a/app/Module/UserMessagesModule.php +++ b/app/Module/UserMessagesModule.php @@ -35,14 +35,22 @@ class UserMessagesModule extends AbstractModule implements ModuleInterface, Modu { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Messages'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Messages” module */ diff --git a/app/Module/UserWelcomeModule.php b/app/Module/UserWelcomeModule.php index 597fe1440a..c8d2b2f4d4 100644 --- a/app/Module/UserWelcomeModule.php +++ b/app/Module/UserWelcomeModule.php @@ -31,14 +31,22 @@ class UserWelcomeModule extends AbstractModule implements ModuleInterface, Modul { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('My page'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “My page” module */ diff --git a/app/Module/WelcomeBlockModule.php b/app/Module/WelcomeBlockModule.php index 4c294a8686..eaed2bde5e 100644 --- a/app/Module/WelcomeBlockModule.php +++ b/app/Module/WelcomeBlockModule.php @@ -31,14 +31,22 @@ class WelcomeBlockModule extends AbstractModule implements ModuleInterface, Modu { use ModuleBlockTrait; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Home page'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Home page” module */ diff --git a/app/Module/YahrzeitModule.php b/app/Module/YahrzeitModule.php index e2efe876e9..d70c5ffbf2 100644 --- a/app/Module/YahrzeitModule.php +++ b/app/Module/YahrzeitModule.php @@ -42,14 +42,22 @@ class YahrzeitModule extends AbstractModule implements ModuleInterface, ModuleBl // Can show this number of days into the future. private const MAX_DAYS = 30; - /** {@inheritdoc} */ + /** + * How should this module be labelled on tabs, menus, etc.? + * + * @return string + */ public function title(): string { /* I18N: Name of a module. Yahrzeiten (the plural of Yahrzeit) are special anniversaries of deaths in the Hebrew faith/calendar. */ return I18N::translate('Yahrzeiten'); } - /** {@inheritdoc} */ + /** + * A sentence describing what this module does. + * + * @return string + */ public function description(): string { /* I18N: Description of the “Yahrzeiten” module. A “Hebrew death” is a death where the date is recorded in the Hebrew calendar. */ |
