Typedo c: Как включить внутренние функции для документации, используя typedoc - PullRequest
1 голос
/ 20 января 2020

Поскольку я использую typedo c для генерации документации, он генерирует документацию только для экспортированных функций и переменных, даже если я установил для excludeNotExported значение false

Вот мои typedocOptions в tsconfig. json

"typedocOptions": {
    "mode": "modules",
    "out": "docs/td",
    "excludeNotExported":false,
}

Showing only exported functions and variables I have other internal function like setConfig as well which are not being shown here

1 Ответ

1 голос
/ 21 января 2020

Решена эта проблема Вы должны установить режим typedo c в 'file' в tsconfig. json, и он будет документировать все неэкспортированные, а также экспортируемые переменные и функции. Другой режим - это «модуль», в котором он генерирует документацию только для экспортируемых материалов (я полагаю, он проверяет только все объявления, добавленные с помощью экспорта ключевых слов).

...