update module annotations and authors

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;

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;

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<FilterState, FilterStateJSON> {
     /**

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';

src/store/palette.ts

@@ -1,10 +1,6 @@
 /**
  * @module store
  */
-
-/**
- *
- */
 import { StoreModule } from '.';
 
 export interface PaletteState {

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

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';

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
     };
 
     /**

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';

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