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