3
0
Fork 0
mirror of https://github.com/farmOS/farmOS.git synced 2024-02-23 11:37:38 +01:00

Add docblock for FarmSettingsModulesForm::moduleOptions().

This class no longer extends from FarmModulesForm, which
originally provided this documentation.
This commit is contained in:
Michael Stenta 2021-08-23 10:39:14 -04:00
parent c68ae68ae9
commit 1e2995f585

View file

@ -125,7 +125,14 @@ class FarmSettingsModulesForm extends FormBase {
}
/**
* {@inheritdoc}
* Helper function for building a list of modules to install.
*
* @return array
* Returns an array with two sub-arrays: `core` and `contrib`. Each of
* these includes three sub-arrays: 'options', 'default' and 'disabled'.
* All modules should be included in the 'options' array. Default modules
* will be selected for installation by default, and disabled modules
* cannot have their checkbox changed by users.
*/
protected function moduleOptions() {