MDL-57629 webservice: Fix external functions phpdoc

Replace external_external_function_parameters with external_function_parameters
yousuftafhim · Jan 11, 2017 · 9db43c7 · 9db43c7
1 parent 8ed0851
commit 9db43c7
Show file tree

Hide file tree

Showing 17 changed files with 58 additions and 58 deletions.
diff --git a/auth/classes/external.php b/auth/classes/external.php
@@ -43,7 +43,7 @@ class core_auth_external extends external_api {
     /**
      * Describes the parameters for confirm_user.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.2
      */
     public static function confirm_user_parameters() {

diff --git a/auth/email/classes/external.php b/auth/email/classes/external.php
@@ -59,7 +59,7 @@ protected static function check_signup_enabled() {
     /**
      * Describes the parameters for get_signup_settings.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.2
      */
     public static function get_signup_settings_parameters() {
@@ -179,7 +179,7 @@ public static function get_signup_settings_returns() {
     /**
      * Describes the parameters for signup_user.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.2
      */
     public static function signup_user_parameters() {

diff --git a/badges/classes/external.php b/badges/classes/external.php
@@ -43,7 +43,7 @@ class core_badges_external extends external_api {
     /**
      * Describes the parameters for get_user_badges.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.1
      */
     public static function get_user_badges_parameters() {

diff --git a/completion/classes/external.php b/completion/classes/external.php
@@ -43,7 +43,7 @@ class core_completion_external extends external_api {
     /**
      * Describes the parameters for update_activity_completion_status_manually.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.9
      */
     public static function update_activity_completion_status_manually_parameters() {
@@ -383,7 +383,7 @@ public static function get_course_completion_status_returns() {
     /**
      * Describes the parameters for mark_course_self_completed.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function mark_course_self_completed_parameters() {

diff --git a/course/externallib.php b/course/externallib.php
@@ -2012,7 +2012,7 @@ public static function delete_categories_returns() {
     /**
      * Describes the parameters for delete_modules.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.5
      */
     public static function delete_modules_parameters() {

diff --git a/grade/report/overview/classes/external.php b/grade/report/overview/classes/external.php
@@ -42,7 +42,7 @@ class gradereport_overview_external extends external_api {
     /**
      * Describes the parameters for get_course_grades.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.2
      */
     public static function get_course_grades_parameters() {

diff --git a/grade/report/user/externallib.php b/grade/report/user/externallib.php
@@ -208,7 +208,7 @@ protected static function get_report_data($course, $context, $user, $userid, $gr
     /**
      * Describes the parameters for get_grades_table.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.9
      */
     public static function get_grades_table_parameters() {
@@ -424,7 +424,7 @@ public static function view_grade_report_returns() {
     /**
      * Describes the parameters for get_grade_items.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.2
      */
     public static function get_grade_items_parameters() {

diff --git a/mod/assign/externallib.php b/mod/assign/externallib.php
@@ -70,7 +70,7 @@ private static function generate_warning($assignmentid, $warningcode, $detail) {
 
     /**
      * Describes the parameters for get_grades
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.4
      */
     public static function get_grades_parameters() {
@@ -660,7 +660,7 @@ private static function get_plugins_data($assign, $assignplugins, $item) {
     /**
      * Describes the parameters for get_submissions
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.5
      */
     public static function get_submissions_parameters() {
@@ -1317,7 +1317,7 @@ public static function get_user_mappings_returns() {
 
     /**
      * Describes the parameters for lock_submissions
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function lock_submissions_parameters() {
@@ -1374,7 +1374,7 @@ public static function lock_submissions_returns() {
 
     /**
      * Describes the parameters for revert_submissions_to_draft
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function revert_submissions_to_draft_parameters() {
@@ -1431,7 +1431,7 @@ public static function revert_submissions_to_draft_returns() {
 
     /**
      * Describes the parameters for unlock_submissions
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function unlock_submissions_parameters() {
@@ -1488,7 +1488,7 @@ public static function unlock_submissions_returns() {
 
     /**
      * Describes the parameters for submit_grading_form webservice.
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 3.1
      */
     public static function submit_grading_form_parameters() {
@@ -1566,7 +1566,7 @@ public static function submit_grading_form($assignmentid, $userid, $jsonformdata
 
     /**
      * Describes the return for submit_grading_form
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 3.1
      */
     public static function submit_grading_form_returns() {
@@ -1575,7 +1575,7 @@ public static function submit_grading_form_returns() {
 
     /**
      * Describes the parameters for submit_for_grading
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function submit_for_grading_parameters() {
@@ -1630,7 +1630,7 @@ public static function submit_for_grading_returns() {
 
     /**
      * Describes the parameters for save_user_extensions
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function save_user_extensions_parameters() {
@@ -1703,7 +1703,7 @@ public static function save_user_extensions_returns() {
 
     /**
      * Describes the parameters for reveal_identities
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function reveal_identities_parameters() {
@@ -1752,7 +1752,7 @@ public static function reveal_identities_returns() {
 
     /**
      * Describes the parameters for save_submission
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function save_submission_parameters() {
@@ -1828,7 +1828,7 @@ public static function save_submission_returns() {
 
     /**
      * Describes the parameters for save_grade
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.6
      */
     public static function save_grade_parameters() {
@@ -1964,7 +1964,7 @@ public static function save_grade_returns() {
 
     /**
      * Describes the parameters for save_grades
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since  Moodle 2.7
      */
     public static function save_grades_parameters() {
@@ -2220,7 +2220,7 @@ public static function view_grading_table_returns() {
     /**
      * Describes the parameters for view_submission_status.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.1
      */
     public static function view_submission_status_parameters() {
@@ -2274,7 +2274,7 @@ public static function view_submission_status_returns() {
     /**
      * Describes the parameters for get_submission_status.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.1
      */
     public static function get_submission_status_parameters() {
@@ -2827,7 +2827,7 @@ protected static function validate_assign($assignid) {
     /**
      * Describes the parameters for view_assign.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.2
      */
     public static function view_assign_parameters() {

diff --git a/mod/book/classes/external.php b/mod/book/classes/external.php
@@ -152,7 +152,7 @@ public static function view_book_returns() {
     /**
      * Describes the parameters for get_books_by_courses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function get_books_by_courses_parameters() {

diff --git a/mod/chat/classes/external.php b/mod/chat/classes/external.php
@@ -494,7 +494,7 @@ public static function view_chat_returns() {
     /**
      * Describes the parameters for get_chats_by_courses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function get_chats_by_courses_parameters() {

diff --git a/mod/choice/classes/external.php b/mod/choice/classes/external.php
@@ -42,7 +42,7 @@ class mod_choice_external extends external_api {
     /**
      * Describes the parameters for get_choices_by_courses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function get_choice_results_parameters() {
@@ -167,7 +167,7 @@ public static function get_choice_results_returns() {
     /**
      * Describes the parameters for mod_choice_get_choice_options.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function get_choice_options_parameters() {
@@ -288,7 +288,7 @@ public static function get_choice_options_returns() {
     /**
      * Describes the parameters for submit_choice_response.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function submit_choice_response_parameters() {
@@ -449,7 +449,7 @@ public static function view_choice_returns() {
     /**
      * Describes the parameters for get_choices_by_courses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function get_choices_by_courses_parameters() {
@@ -587,7 +587,7 @@ public static function get_choices_by_courses_returns() {
     /**
      * Describes the parameters for delete_choice_responses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function delete_choice_responses_parameters() {

diff --git a/mod/data/classes/external.php b/mod/data/classes/external.php
@@ -42,7 +42,7 @@ class mod_data_external extends external_api {
     /**
      * Describes the parameters for get_databases_by_courses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.9
      */
     public static function get_databases_by_courses_parameters() {

diff --git a/mod/forum/externallib.php b/mod/forum/externallib.php
@@ -32,7 +32,7 @@ class mod_forum_external extends external_api {
     /**
      * Describes the parameters for get_forum.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.5
      */
     public static function get_forums_by_courses_parameters() {
@@ -152,7 +152,7 @@ public static function get_forums_by_courses_returns() {
     /**
      * Describes the parameters for get_forum_discussion_posts.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.7
      */
     public static function get_forum_discussion_posts_parameters() {
@@ -350,7 +350,7 @@ public static function get_forum_discussion_posts_returns() {
     /**
      * Describes the parameters for get_forum_discussions_paginated.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 2.8
      */
     public static function get_forum_discussions_paginated_parameters() {

diff --git a/mod/glossary/classes/external.php b/mod/glossary/classes/external.php
@@ -169,7 +169,7 @@ protected static function validate_glossary($id) {
     /**
      * Describes the parameters for get_glossaries_by_courses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.1
      */
     public static function get_glossaries_by_courses_parameters() {

diff --git a/mod/imscp/classes/external.php b/mod/imscp/classes/external.php
@@ -107,7 +107,7 @@ public static function view_imscp_returns() {
     /**
      * Describes the parameters for get_imscps_by_courses.
      *
-     * @return external_external_function_parameters
+     * @return external_function_parameters
      * @since Moodle 3.0
      */
     public static function get_imscps_by_courses_parameters() {