Dox

Dox разбирает код JavaScript, извлекая код комментарии и собирая их в странице документации, созданной с помощью Markdown и JSDoc меток.
Сформированный страница документации содержится в одном файле, без внешних JS или CSS-файлов.
Dox приходит как простой в использовании исполняемый, а также в виде отдельного файла развертывания.
Dox была построена, чтобы быть использован только из Node.js CLI

Что нового В этом выпуске:

• Добавлена:.
• Поддержкаdescription тега
• Контекст матч за возврат закрытия
• Метки без описаний теперь есть HTML имущество, содержащий уценки разбор содержимого тега
• Исправления:
• Подробнее агностик к коду стиле при разборе контексты (например, больше не игнорирует их без пробелов между именем функции и скобкой)
• Нет больше неправильно не пытается разобрать строки внутри комментариев, в результате чего большие куски файла будут проигнорированы.
• Нет больше разбирает двойной слэш в строке буквальное как комментарий начало.

Что нового в версии 0.7.1:

• Добавлена:
• Поддержкаdescription тега
• Контекст матч за возврат закрытия
• Метки без описаний теперь есть HTML имущество, содержащий уценки разбор содержимого тега
• Исправления:
• Подробнее агностик к коду стиле при разборе контексты (например, больше не игнорирует их без пробелов между именем функции и скобкой)
• Нет больше неправильно не пытается разобрать строки внутри комментариев, в результате чего большие куски файла будут проигнорированы.
• Нет больше разбирает двойной слэш в строке буквальное как комментарий начало.

Что нового в версии 0.5.1:

• Исправлено:
• * / * перерывы разбора

Что нового в версии 0.4.6:.

• Не обернутьexample содержимое с Markdown

Что нового в версии 0.4.4:

• Добавлена ​​поддержка имен переменных, содержащих & Quot; $ & Quot ;.

Что нового в версии 0.4.2:

• Предотвращение ошибок при использовании --api & замечания нет пример кода.

Что нового в версии 0.4.1:

• Изменить # для. в --api.

Что нового в версии 0.4.0:.

• Добавлена ​​GFM блоки кода
• Удалено неявные названия.

Что нового в версии 0.3.3:.

• Исправлена ​​--api .receiver

Что нового в версии 0.3.1:.

• Исправлена ​​ошибка раздражает название

Что нового в версии 0.2.0:.

• Добавлена ​​-r, --raw поддержка

Что нового в версии 0.1.3:

• Добавлена:. позволяют произвольные теги
• Исправлена ​​функция пробелы.

Что нового в версии 0.1.2:.

• Удален HTML побега сейчас

Что нового в версии 0.1.1:

• Исправлено:
• Двоеточия в строки комментариев не предназначен в качестве заголовков.

Что нового в версии 0.0.5:

• Добавление и Quot; основной и Quot; упаковать дескриптор так и Quot; каталоги и Quot; больше не поддерживаются.

Что нового в версии 0.0.4:

• Добавлена ​​поддержка для --intro в том числе файл интро написано в уценкой.

Требования

• Node.js