From 14162d1b3bf5ee0080d114a09f905860c6509692 Mon Sep 17 00:00:00 2001 From: Dennis de Best Date: Mon, 30 Jan 2023 10:53:05 +0100 Subject: [PATCH 1/2] Fix annotations on settings.rst The return of `public function getIcon()` was set to the description and not to a valid type. This fixes that and cleans the other annotations. Signed-off-by: Dennis de Best --- developer_manual/digging_deeper/settings.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/developer_manual/digging_deeper/settings.rst b/developer_manual/digging_deeper/settings.rst index 4d0eac649..242cbeb94 100644 --- a/developer_manual/digging_deeper/settings.rst +++ b/developer_manual/digging_deeper/settings.rst @@ -101,7 +101,9 @@ on the survey_client solution. } /** - * @return string the section ID, e.g. 'sharing' + * The section ID, e.g. 'sharing' + * + * @return string */ public function getSection() { return 'survey_client'; @@ -229,7 +231,7 @@ An example implementation of the IIconSection interface: } /** - * returns the ID of the section. It is supposed to be a lower case string + * Returns the ID of the section. It is supposed to be a lower case string * * @returns string */ @@ -238,7 +240,7 @@ An example implementation of the IIconSection interface: } /** - * returns the translated name as it should be displayed, e.g. 'LDAP / AD + * Returns the translated name as it should be displayed, e.g. 'LDAP / AD * integration'. Use the L10N service to translate it. * * @return string @@ -248,16 +250,20 @@ An example implementation of the IIconSection interface: } /** - * @return int whether the form should be rather on the top or bottom of + * Whether the form should be rather on the top or bottom of * the settings navigation. The sections are arranged in ascending order of * the priority values. It is required to return a value between 0 and 99. + * + * @return int */ public function getPriority() { return 80; } /** - * @return The relative path to a an icon describing the section + * The relative path to a an icon describing the section + * + * @return string */ public function getIcon() { return $this->urlGenerator->imagePath('yourapp', 'icon.svg'); From d7d57455c6ea3c8984542f4df7ac21646cb36789 Mon Sep 17 00:00:00 2001 From: Dennis de Best Date: Wed, 1 Feb 2023 04:52:29 +0100 Subject: [PATCH 2/2] Update settings.rst Signed-off-by: Dennis de Best --- developer_manual/digging_deeper/settings.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/developer_manual/digging_deeper/settings.rst b/developer_manual/digging_deeper/settings.rst index 242cbeb94..a7ec7ed56 100644 --- a/developer_manual/digging_deeper/settings.rst +++ b/developer_manual/digging_deeper/settings.rst @@ -110,9 +110,11 @@ on the survey_client solution. } /** - * @return int whether the form should be rather on the top or bottom of + * Whether the form should be rather on the top or bottom of * the admin section. The forms are arranged in ascending order of the * priority values. It is required to return a value between 0 and 100. + * + * @return int */ public function getPriority() { return 50;