MOBILE-3213 core: Run script that removes types from JSDoc

main
Dani Palou 2019-12-11 08:21:20 +01:00
parent b427c8a52a
commit 8d30c0be97
13 changed files with 15 additions and 17 deletions

View File

@ -327,7 +327,7 @@ export class AddonBlockMyOverviewComponent extends CoreBlockBaseComponent implem
/**
* Set selected courses filter.
*
* @param {string} filter Filter name to set.
* @param filter Filter name to set.
*/
protected setCourseFilter(filter: string): void {
this.selectedFilter = filter;

View File

@ -437,8 +437,6 @@ export class AddonCalendarListPage implements OnDestroy {
});
}
/**
*/
protected filterEvents(): void {
this.filteredEvents = this.calendarHelper.getFilteredEvents(this.events, this.filter, this.categories);
}

View File

@ -101,7 +101,7 @@ export class AddonModDataFieldLatlongComponent extends AddonModDataFieldPluginCo
/**
* Get user location.
*
* @param {Event} $event The event.
* @param $event The event.
*/
getLocation(event: Event): void {
event.preventDefault();

View File

@ -600,7 +600,7 @@ export class AddonModForumProvider {
* @param siteId Site ID. If not defined, current site.
* @return Promise resolved with an object with:
* - discussions: List of discussions. Note that for every discussion in the list discussion.id is the main post ID but
* discussion ID is discussion.discussion.
* discussion ID is discussion.discussion.
* - canLoadMore: True if there may be more discussions to load.
*/
getDiscussions(forumId: number, sortOrder?: number, page: number = 0, forceCache?: boolean, siteId?: string): Promise<any> {

View File

@ -1903,7 +1903,7 @@ export class CoreSite {
* Get a certain cache expiration delay.
*
* @param updateFrequency The update frequency of the entry.
* @return {number} Expiration delay.
* @return Expiration delay.
*/
getExpirationDelay(updateFrequency?: number): number {
let expirationDelay = this.UPDATE_FREQUENCIES[updateFrequency] || this.UPDATE_FREQUENCIES[CoreSite.FREQUENCY_USUALLY];

View File

@ -1127,7 +1127,7 @@ export class CoreCourseHelperProvider {
* @param courseId Course ID. If not defined we'll try to retrieve it from the site.
* @param sectionId Section the module belongs to. If not defined we'll try to retrieve it from the site.
* @param useModNameToGetModule If true, the app will retrieve all modules of this type with a single WS call. This reduces the
* number of WS calls, but it isn't recommended for modules that can return a lot of contents.
* number of WS calls, but it isn't recommended for modules that can return a lot of contents.
* @param modParams Params to pass to the module
* @param navCtrl NavController for adding new pages to the current history. Optional for legacy support, but
* generates a warning if omitted.

View File

@ -65,7 +65,7 @@ export class CoreFilterDefaultHandler implements CoreFilterHandler {
/**
* Whether or not the handler is enabled on a site level.
*
* @return {boolean|Promise<boolean>} Whether or not the handler is enabled on a site level.
* @return Whether or not the handler is enabled on a site level.
*/
isEnabled(): boolean | Promise<boolean> {
return true;

View File

@ -236,7 +236,7 @@ export class CoreFilterDelegate extends CoreDelegate {
* @param filter Filter to check.
* @param options Options passed to the filters.
* @param site Site. If not defined, current site.
* @return {Promise<boolean>} Promise resolved with true: whether the filter should be applied.
* @return Promise resolved with true: whether the filter should be applied.
*/
shouldBeApplied(filters: CoreFilterFilter[], options: CoreFilterFormatTextOptions, site?: CoreSite): Promise<boolean> {
// Wait for filters to be initialized.

View File

@ -681,8 +681,8 @@ export class CoreH5PContentValidator {
* Processes an HTML tag.
*
* @param m An array with various meaning depending on the value of store.
* If store is TRUE then the array contains the allowed tags.
* If store is FALSE then the array has one element, the HTML tag to process.
* If store is TRUE then the array contains the allowed tags.
* If store is FALSE then the array has one element, the HTML tag to process.
* @param store Whether to store m.
* @return string If the element isn't allowed, an empty string. Otherwise, the cleaned up version of the HTML element.
*/

View File

@ -66,7 +66,7 @@ export class CoreH5PPluginFileHandler implements CorePluginFileHandler {
* CoreFilepoolProvider.extractDownloadableFilesFromHtml.
*
* @param container Container where to get the URLs from.
* @return {string[]} List of URLs.
* @return List of URLs.
*/
getDownloadableFilesFromHTML(container: HTMLElement): string[] {
const iframes = <HTMLIFrameElement[]> Array.from(container.querySelectorAll('iframe.h5p-iframe'));

View File

@ -164,7 +164,7 @@ export class CoreAppProvider {
/**
* Returns whether the user agent is controlled by automation. I.e. Behat testing.
*
* @return {boolean} True if the user agent is controlled by automation, false otherwise.
* @return True if the user agent is controlled by automation, false otherwise.
*/
static isAutomated(): boolean {
return !!navigator.webdriver;

View File

@ -71,7 +71,7 @@ export interface CorePluginFileHandler extends CoreDelegateHandler {
* CoreFilepoolProvider.extractDownloadableFilesFromHtml.
*
* @param container Container where to get the URLs from.
* @return {string[]} List of URLs.
* @return List of URLs.
*/
getDownloadableFilesFromHTML?(container: HTMLElement): string[];

View File

@ -78,8 +78,8 @@ export class CoreTextUtilsProvider {
/**
* Add ending slash from a path or URL.
*
* @param {string} text Text to treat.
* @return {string} Treated text.
* @param text Text to treat.
* @return Treated text.
*/
addEndingSlash(text: string): string {
if (!text) {
@ -742,7 +742,7 @@ export class CoreTextUtilsProvider {
* @param replace The value to put inside the string.
* @param start The index where to start putting the new string. If negative, it will count from the end of the string.
* @param length Length of the portion of string which is to be replaced. If negative, it represents the number of characters
* from the end of string at which to stop replacing. If not provided, replace until the end of the string.
* from the end of string at which to stop replacing. If not provided, replace until the end of the string.
* @return Treated string.
*/
substrReplace(str: string, replace: string, start: number, length?: number): string {