MDL-64790 upgrade: parameter API doc regression fix

Partially update the API documentation of function
upgrade_plugin_savepoint.

This restores consistency between function parameters and API
documentation; as commit 17da2e6f28 (fix
for MDL-16438) had renamed parameter $dir to $plugin, but not also
applied this change to the API documentation.

Also reword the parameter comment text so that it is more meaningful to
developers: document that the parameter contains the name of the plugin.

Change the API documentation of parameter $type as well so that it is
a) correct, and
b) not in conflict with the API documentation for $plugin.
This commit is contained in:
Nicolas Roeser
2019-03-15 11:11:44 +01:00
parent b1376641d4
commit 43121fbe8b
+2 -2
View File
@@ -383,8 +383,8 @@ function upgrade_block_savepoint($result, $version, $blockname, $allowabort=true
* @category upgrade
* @param bool $result false if upgrade step failed, true if completed
* @param string or float $version main version
* @param string $type name of plugin
* @param string $dir location of plugin
* @param string $type The type of the plugin.
* @param string $plugin The name of the plugin.
* @param bool $allowabort allow user to abort script execution here
* @return void
*/