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

после проведения некоторых исследований о лучшем способе документирования swift-кода. Я столкнулся с Jazzy и как просто это было реализовать. Поэтому я следую разделу установки Jazzy Документация. Я бегу!--5-->

sudo gem install jazzy

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

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

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

Я:

  • jazzy версия: 0.3.2
  • версия Xcode: 7.1
  • Swift версия: 2.1
  • OS X El Capitan версия: 10.11

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

2 ответов


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

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

который находится в неприятности съемки части jazzy Git hub страница

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

jazzy --min-acl private

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


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