как использовать appledoc для создания Apple-подобных документов - PullRequest
9 голосов
/ 21 марта 2012

Я читаю в статье, как генерировать Apple-подобную HTML документацию на здесь Мои вопросы - для чего используются командные строки.Как мы можем объединить командные строки и проект appledoc xcode для генерации HTML.

Ответы [ 3 ]

19 голосов
/ 27 марта 2012

Я автор инструмента appledoc.Инструмент предназначен для использования в соответствии с ответом Калеба выше.Рекомендуемый метод установки - клонировать репозиторий из GitHub, открыть проект в XCode, собрать и при желании скопировать двоичный файл на ваш путь, как предложено выше.Кроме того, вы также должны скопировать файлы шаблона, необходимые для запуска инструмента, по одному из предопределенных путей.Все необходимые шаги описаны в файле readme на странице appledoc на GitHub , см. Раздел «Быстрая установка».

Существуют и другие способы установки - все комментарии пользователей:

  • Вы можете использовать скрипт install-appledoc.sh, включенный в репозиторий git.
  • Также имеется рецепт homebrew , хотя он не устанавливает файлы шаблонов, насколько я понимаю (см. эта ссылка ).

По всем дополнительным вопросам обращайтесь в appledoc Google group .Я только что создал его несколько дней назад, поэтому на момент написания этой статьи никакого контента нет, но не стесняйтесь задавать вопросы там.

13 голосов
/ 21 марта 2012

Я не использовал appledoc, но при быстром взгляде на страницу, которую вы связали, выясняется, что это утилита командной строки с открытым исходным кодом. Таким образом, первым шагом будет компиляция самой программы appledoc, а затем добавление ее в каталог по вашему пути, например /usr/local/bin или ~/bin/.

Следующий шаг - попытаться использовать его для генерации некоторой документации (при условии, что вы уже создали файлы уценки, которые он использует). Откройте окно терминала, перейдите в каталог, где находятся ваши файлы, а затем используйте команду, указанную в верхней части страницы, на которую вы ссылались:

appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .

Если вы хотите использовать appledoc для регенерации вашей документации каждый раз, когда вы создаете какой-либо проект, вы можете добавить фазу сборки «Run Script» к существующей цели в вашем проекте или создать новую цель только для документации, которая имеет ничего, кроме фазы "Run Script". В любом случае, сценарий на этом этапе должен быть сценарием оболочки, содержащим команду, аналогичную приведенной выше (хотя вы, вероятно, захотите явно указать исходный каталог, а не просто использовать текущий каталог, т. Е. .).

4 голосов
/ 24 апреля 2014

Как я обнаружил в этом сообщении , вы можете сгенерировать полную документацию HTML своего кода с помощью этой командной строки:

appledoc --проект-имя BabelCPP --проект-компания "Мое имя" --company-id com.mycompany --no-create-docset --output ./doc/.

Последний "." это путь к вашему коду.

...