mirrors/nextcloud-documentation
3
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-10-26 11:18:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9628 from nextcloud/backport/9595/stable24

Browse Source 
[stable24] Fix annotations on settings.rst
This commit is contained in:
MichaIng 2023-02-10 18:54:08 +01:00 committed by GitHub
commit 65b86a9cc0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
developer_manual/digging_deeper/settings.rst
View File

@ -101,16 +101,20 @@ 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';
}
/**
* @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;
@ -229,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
*/
@ -238,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
@ -248,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');