add JSDoc comments to start describing each class

Author: trusktr

src/core/Docsify.js

@@ -7,6 +7,7 @@ import { renderMixin } from './render';
 import { fetchMixin } from './fetch';
 import { eventMixin } from './event';
 
+/** This class contains all the magic. */
 export class Docsify extends multiple(
   initMixin,
   lifecycleMixin,

src/core/event/index.js

@@ -3,6 +3,13 @@ import { body, on } from '../util/dom';
 import * as sidebar from './sidebar';
 import { scrollIntoView, scroll2Top } from './scroll';
 
+/**
+ * This class wires up some UI events using the `sidebar` utility. On each
+ * route change it re-initializes the events because the sidebar is re-rendered
+ * each time we go to a new page.
+ */
+// TODO @trusktr, this should need to re-initialize events, and the sidebar
+// should not be re-rendered each time.
 export function eventMixin(Base = class {}) {
   return class extends Base {
     $resetEvents(source) {

src/core/fetch/index.js

@@ -4,6 +4,10 @@ import { noop } from '../util/core';
 import { getAndActive } from '../event/sidebar';
 import { get } from './ajax';
 
+/**
+ * This class provides methods for fetching content (f.e. markdown pages). It
+ * coordinates renderMixin with help from the router.
+ */
 export function fetchMixin(Base = class {}) {
   return class extends Base {
     constructor() {

src/core/init/index.js

@@ -1,5 +1,9 @@
 import config from '../config';
 
+/**
+ * This class is responsible to initializing all other mixins in a certain
+ * order, and calling lifecycle hooks at appropriate times.
+ */
 export function initMixin(Base = class {}) {
   return class extends Base {
     constructor() {

src/core/lifecycle/index.js

@@ -1,5 +1,6 @@
 import { noop } from '../util/core';
 
+/** This class sets of lifecycle hooks that plugins can hook into. */
 export function lifecycleMixin(Base = class {}) {
   return class Lifecycle extends Base {
     initLifecycle() {

src/core/plugin/index.js

@@ -1,5 +1,6 @@
 import { isFn } from '../util/core';
 
+/** This class gets all plugins that were specified in the Docsify config can calls them. */
 export function pluginMixin(Base = class {}) {
   return class Plugin extends Base {
     initPlugin() {

src/core/render/compiler.js

@@ -57,6 +57,10 @@ const compileMedia = {
   },
 };
 
+/**
+ * This class compiles the markdown of each page of a Docsify site into HTML
+ * (using some information from the provided router).
+ */
 export class Compiler {
   constructor(config, router) {
     this.config = config;

src/core/render/index.js

@@ -11,6 +11,11 @@ import { Compiler } from './compiler';
 import * as tpl from './tpl';
 import { prerenderEmbed } from './embed';
 
+/**
+ * This class is provides methods for rendering the Docsify site content using
+ * the Compiler to convert markdown into HTML. It wires up the Compiler with
+ * the router.
+ */
 export function renderMixin(Base = class {}) {
   return class extends Base {
     _executeScript() {
@@ -86,6 +91,7 @@ export function renderMixin(Base = class {}) {
         el.setAttribute('href', nameLink[match]);
       }
     }
+
     _renderTo(el, content, replace) {
       const node = dom.getNode(el);
       if (node) {

src/core/router/index.js

@@ -4,6 +4,10 @@ import { noop } from '../util/core';
 import { HashHistory } from './history/hash';
 import { HTML5History } from './history/html5';
 
+/**
+ * This class wires up the mechanisms that react to URL changes of the browser
+ * address bar.
+ */
 export function routerMixin(Base = class {}) {
   return class extends Base {
     constructor() {