JSDoc: показать вложенное дерево модулей вместо списка всех модулей в проекте - PullRequest
Новая
       31

JSDoc: показать вложенное дерево модулей вместо списка всех модулей в проекте

0 голосов
/ 29 октября 2018

Я пытаюсь сгенерировать jsdoc для проекта среднего размера. Структура проекта выглядит следующим образом: 

-src
--commands
--components
---dirA
----ComponentA.js
---dirB
----ComponentB.js
--config
--constant
--page
---pageDirA
----PageA.js
---pageDirB
----PageB.js
--util

Если я сгенерирую jsdoc для этого, я просто получу список всех модулей на боковой панели. Если бы я включил все классы / модули, он создал бы огромный список, по которому нелегко ориентироваться.

пример класса / модуля: 

import Header from '../component/Header';

/**
 * The abstract pager modal containing components and configuration that is used on all pages.
 *
 * @author Cornel
 * @module
 */
class AbstractPage {

  constructor() {
    this._url = '';

    this._header = new Header();
  }

  get url() {
    return this._url;
  }

  get header() {
    return this._header;
  }
}

export default AbstractPage;

Есть ли способ сделать это, чтобы у меня была древовидная структура сгенерированной документации, использующей jsDoc?

...