diff --git a/src/components/MainContent.ts b/src/components/MainContent.ts index a42cc1e9..c47e8ccd 100644 --- a/src/components/MainContent.ts +++ b/src/components/MainContent.ts @@ -1,7 +1,14 @@ +/** + * @module components + */ import { Component } from 'vue-property-decorator'; import Store from '../store'; import config from '../config'; +/** + * the container for the notification and content right of the side bar + * @author Hanzhi Zhou + */ @Component export default class MainContent extends Store { scrollable = false; diff --git a/src/components/URLModal.ts b/src/components/URLModal.ts index efc679c6..4dd70fcd 100644 --- a/src/components/URLModal.ts +++ b/src/components/URLModal.ts @@ -1,6 +1,13 @@ +/** + * @module components + */ import $ from 'jquery'; import 'bootstrap'; import { Vue, Component, Prop } from 'vue-property-decorator'; +/** + * component for displaying and copying URL created by [[ExportView]] + * @author Hanzhi Zhou + */ @Component export default class URLModal extends Vue { @Prop(String) readonly url!: string; diff --git a/src/store/filter.ts b/src/store/filter.ts index d5370c98..b3ffc490 100644 --- a/src/store/filter.ts +++ b/src/store/filter.ts @@ -1,10 +1,5 @@ /** * @module store - * @author Hanzhi Zhou - */ - -/** - * */ import ScheduleEvaluator, { SortMode, @@ -165,7 +160,8 @@ function getDefaultOptions() { window.scheduleEvaluator = new ScheduleEvaluator(getDefaultOptions(), window.timeMatrix); /** - * the filter module handles the manipulation of filters + * the filter module handles the storage and manipulation of filters + * @author Hanzhi Zhou */ class FilterStore implements StoreModule { /** diff --git a/src/store/index.ts b/src/store/index.ts index 2a199b87..f801a98c 100644 --- a/src/store/index.ts +++ b/src/store/index.ts @@ -1,3 +1,14 @@ +/** + * The Store module provides methods to save, retrieve and manipulate store. + * It gathers all children modules and store their references in a single store class, + * which is provided as a Mixin + * @module store + * @preferred + */ + +/** + * + */ import Store from './store'; export default Store; export * from './store'; diff --git a/src/store/palette.ts b/src/store/palette.ts index 735830e8..24793a8a 100644 --- a/src/store/palette.ts +++ b/src/store/palette.ts @@ -1,10 +1,6 @@ /** * @module store */ - -/** - * - */ import { StoreModule } from '.'; export interface PaletteState { diff --git a/src/store/profile.ts b/src/store/profile.ts index f452833d..6e5f90c8 100644 --- a/src/store/profile.ts +++ b/src/store/profile.ts @@ -1,6 +1,15 @@ +/** + * @module store + */ import { SemesterJSON } from '@/models/Catalog'; import { SemesterStorage } from '.'; +/** + * the profile class handles profiles adding, renaming and deleting + * @note profile selection is handled in the [[Store]] class + * because it also needs to manipulate other store modules + * @author Hanzhi Zhou + */ class Profile { /** * a reactive property. whenever changed, the `currentProfile` in the `localStorage` will be updated diff --git a/src/store/semester.ts b/src/store/semester.ts index 68d02fef..727a0ac2 100644 --- a/src/store/semester.ts +++ b/src/store/semester.ts @@ -1,10 +1,6 @@ /** * @module store */ - -/** - * - */ import { loadSemesterData } from '../data/CatalogLoader'; import { loadSemesterList } from '../data/SemesterListLoader'; import { SemesterJSON } from '../models/Catalog'; diff --git a/src/store/status.ts b/src/store/status.ts index fb25e669..abf27b26 100644 --- a/src/store/status.ts +++ b/src/store/status.ts @@ -1,10 +1,6 @@ /** * @module store */ - -/** - * - */ import Event from '../models/Event'; interface Sidebars { @@ -51,7 +47,7 @@ class Status { showInfo: false, showExternal: false, showLog: false, - showCompare: false, + showCompare: false }; /** diff --git a/src/store/store.ts b/src/store/store.ts index 68651d49..975cacde 100644 --- a/src/store/store.ts +++ b/src/store/store.ts @@ -1,13 +1,5 @@ /** - * The Store module provides methods to save, retrieve and manipulate store. - * It gathers all children modules and store their references in a single store class, - * which is provided as a Mixin * @module store - * @preferred - */ - -/** - * */ import { Vue, Component } from 'vue-property-decorator'; import { EvaluatorOptions } from '../algorithm/ScheduleEvaluator'; diff --git a/src/store/watch.ts b/src/store/watch.ts index e6d7ef5f..0bf97b7d 100644 --- a/src/store/watch.ts +++ b/src/store/watch.ts @@ -1,9 +1,13 @@ +/** + * @module store + */ import { Component, Watch } from 'vue-property-decorator'; import Store from './store'; import Schedule from '@/models/Schedule'; /** * the watch factory defines some watchers on the members in `Store`. * these watchers are defined outside of the `Store` class because they should only be registered once. + * @author Hanzhi Zhou */ @Component // tslint:disable-next-line: max-classes-per-file