MOBILE-2061 core: Fix sync param JSDoc

main
dpalou 2018-10-04 17:20:54 +02:00
parent 15b4b6b8d1
commit 1c6618b42a
13 changed files with 14 additions and 14 deletions

View File

@ -136,7 +136,7 @@ export class AddonModAssignIndexComponent extends CoreCourseModuleMainActivityCo
* Get assignment data. * Get assignment data.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -57,7 +57,7 @@ export class AddonModChatIndexComponent extends CoreCourseModuleMainActivityComp
* Download chat. * Download chat.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -112,7 +112,7 @@ export class AddonModChoiceIndexComponent extends CoreCourseModuleMainActivityCo
* Download choice contents. * Download choice contents.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -154,7 +154,7 @@ export class AddonModDataIndexComponent extends CoreCourseModuleMainActivityComp
* Download data contents. * Download data contents.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -147,7 +147,7 @@ export class AddonModFeedbackIndexComponent extends CoreCourseModuleMainActivity
* Download feedback contents. * Download feedback contents.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -106,7 +106,7 @@ export class AddonModLessonIndexComponent extends CoreCourseModuleMainActivityCo
* Get the lesson data. * Get the lesson data.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -58,7 +58,7 @@ export class AddonModLtiIndexComponent extends CoreCourseModuleMainActivityCompo
* Get the LTI data. * Get the LTI data.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -148,7 +148,7 @@ export class AddonModQuizIndexComponent extends CoreCourseModuleMainActivityComp
* Get the quiz data. * Get the quiz data.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -137,7 +137,7 @@ export class AddonModScormIndexComponent extends CoreCourseModuleMainActivityCom
* Get the SCORM data. * Get the SCORM data.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -93,7 +93,7 @@ export class AddonModSurveyIndexComponent extends CoreCourseModuleMainActivityCo
* Download survey contents. * Download survey contents.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -213,7 +213,7 @@ export class AddonModWikiIndexComponent extends CoreCourseModuleMainActivityComp
* Get the wiki data. * Get the wiki data.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -177,7 +177,7 @@ export class AddonModWorkshopIndexComponent extends CoreCourseModuleMainActivity
* Download feedback contents. * Download feedback contents.
* *
* @param {boolean} [refresh=false] If it's refreshing content. * @param {boolean} [refresh=false] If it's refreshing content.
* @param {boolean} [sync=false] If the refresh is needs syncing. * @param {boolean} [sync=false] If it should try to sync.
* @param {boolean} [showErrors=false] If show errors to the user of hide them. * @param {boolean} [showErrors=false] If show errors to the user of hide them.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */

View File

@ -160,7 +160,7 @@ export class CoreCourseSectionPage implements OnDestroy {
* Fetch and load all the data required for the view. * Fetch and load all the data required for the view.
* *
* @param {boolean} [refresh] If it's refreshing content. * @param {boolean} [refresh] If it's refreshing content.
* @param {boolean} [sync] If the refresh is needs syncing. * @param {boolean} [sync] If it should try to sync.
* @return {Promise<any>} Promise resolved when done. * @return {Promise<any>} Promise resolved when done.
*/ */
protected loadData(refresh?: boolean, sync?: boolean): Promise<any> { protected loadData(refresh?: boolean, sync?: boolean): Promise<any> {
@ -342,7 +342,7 @@ export class CoreCourseSectionPage implements OnDestroy {
/** /**
* Refresh list after a completion change since there could be new activities. * Refresh list after a completion change since there could be new activities.
* *
* @param {boolean} [sync] If the refresh is needs syncing. * @param {boolean} [sync] If it should try to sync.
*/ */
protected refreshAfterCompletionChange(sync?: boolean): void { protected refreshAfterCompletionChange(sync?: boolean): void {
// Save scroll position to restore it once done. // Save scroll position to restore it once done.