khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Fix annotations on settings.rst

Browse Source 
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 <dennis@debest.fr>
This commit is contained in:
Dennis de Best
2023-01-30 10:53:05 +01:00
committed by GitHub
parent ef60f0da75
commit b2bfdd48a4
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
developer_manual/digging_deeper/settings.rst
View File

@@ -103,7 +103,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';
@@ -231,7 +233,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
*/
@@ -240,7 +242,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
@@ -250,16 +252,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');