v4fire project documentation issues

[bonkalol]

JSDOC

jsdoc/newline-after-description

Сейчас работает так, что перед тегом обязательно должен быть отступ (настраивается только так). Нужно иметь настройку такого вида:

• Если в описании две строки и более - нужен отступ
• Если в описании одна строка - отступ не нужен

jsdoc/require-description-complete-sentence

Сейчас работает так, что после каждого предложения обязательно должна быть точка. Нужно иметь настройку такого вида:

• Если одно предложение - точка не нужна
• Два и более предложения - точка нужна

jsdoc/require-file-overview

Правило которое требует описания файла (модуля). Сейчас работает для всех файлов. Нам нужно иметь настройку добавлять только для index.ts, b-*, p-*, i-* файлов.

packageDocumentation, typeparam, decorator

Нет такого тега - решается добавление в definedTags в eslint конфиге

Работа с перегрузками

1. Все перегрузки должны иметь JSDOC
2. Реализация должна иметь @inheritDoc вместо описания

jsdoc/check-types Несоответсвие между нашим форматом emits и fires в jsdoc

Описания исходящего события не соответствуют стадарту jsodc, более того стандарт jsdoc достаточно скромно позволяет описать payload события

(Фиксится добавлением emits в definedTags, но тогда никакой валидации, нужно писать свой плагин для валидации)

Миграция

• Обязательно указывать все @param для параметров, включая this;
• Для имплементации функции с перегрузками указываем @inheritdoc в документции, все перегрузки должны быть задокументированы;
• В JS все параметры должны иметь тип;
• В JS теперь вместо типа Object должен использоваться тип object (vscode не понимает что такое Object + валидно использовать именно object);
• В функции которые выкидывают исключения обязательно должны быть помечены тегом @throws;
• В местах где документция выводится исходя из типа переменной например, не нужно использовать @see - используйте @inheritdoc;

typedoc

link issues

Сейчас ссылки на модули сделаны с помощью [[module]] - они не работают, правильный способ использовать @link.

Так же есть проблема с выводом документации типов:

Если этот тип сделать интерфейсом то документация становится значительно более детальной