Документирование простого JavaScript объекта в sphinx- js - PullRequest
Новая
       30

Документирование простого JavaScript объекта в sphinx- js

0 голосов
/ 26 мая 2020

У меня есть объект, который задокументирован с использованием тегов JSDo c, 

/**
 * Some description of this object.
 * @memberof Constants#
 * @readonly
 * @enum {string}
 * @property {string} CONST1 Explanation of const 1.
 * @property {string} CONST2 Explanation of const 2.
 */
 SomeObject: {
     CONST1: "const1",
     CONST2: "const2"
 },

При создании документов с использованием sphinx- js только имя, описание и тип (здесь это строка ) задокументирован, но не упоминаются свойства CONST1 или CONST2.

Есть ли способ, которым sphinx- js может отображать значения свойств этого объекта? Есть ли обходной путь, который я могу сделать?

1 Ответ

0 голосов
/ 27 мая 2020

Не похоже, что sphinx-js поддерживает это в настоящее время. Из проекта README :

Пока что мы понимаем и конвертируем теги блока JSDo c @param, @returns, @throws, @example (без опционального) , @deprecated, @see и их синонимы. Другие будут go в эфир.

К сожалению, я не сразу вижу обходной путь для этого.

...