Jazzy работает не так, как ожидалось, для создания быстрой документации

После некоторого исследования наилучшего способа документировать быстрый код. Я наткнулся на Jazzy и как просто было реализовать. Поэтому я следую разделу установки Jazzy Documentation. Я запустил

Затем я перехожу к корню моего проекта в терминале и запускаю jazzy, который создает папку под названием "docs" с веб-сайтом, на котором отображается документация для 1 класса. У меня есть 87 классов, которые я вижу наглядно, чтобы на выходе терминала выполнялось jazzy.

Я прочитал Учебное пособие NSHipster о документировании кода, который также связывает вас с Jazzy Documentation, а также Ссылка на форматирование разметки. Я документировал некоторый код, который Xcode корректно отображает на боковой панели или правой кнопкой мыши по функции или классу. Поэтому я уверен, что мой синтаксис верен.

Я потратил некоторое время, чтобы сравнить этот 1 файл с другим файлом, который не отображается, и я не вижу ничего необычного в отношении формата.

Мой общий вопрос: Почему не язвительно производя документацию для всех классов и как я могу исправить эту проблему?

Ответы

Ответ 1

После более подробной информации о jazzy в глубине я нашел эту важную часть информации.

По умолчанию, jazzy только документы публичные объявления. Генерировать документация для деклараций с более низким уровнем доступности (внутренний или закрытый), установите флаг -min-acl для внутреннего или частный.

Что находится в разделе устранения проблем на странице jazzy git hub

Я запускал jazzy со следующей строкой для создания ожидаемой документации:

jazzy --min-acl private

Примечание Я должен прочитать все, прежде чем я решил, что что-то не работает правильно.

Ответ 2

Чтобы было еще лучше. использование
jazzy --min-acl internal --skip-undocumented
Пояснение:
--min-acl internal Это будет включать все функции, классы, структуры в вашем документальном фильме.
--skip-undocumented это игнорирует все недокументированные классы...