Как использовать appledoc для создания Apple-подобных документов

Question

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

Answer 1

Я не использовал 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". В любом случае, сценарий на этом этапе должен быть сценарием оболочки, содержащим команду, аналогичную приведенной выше (хотя вы, вероятно, захотите явно указать исходный каталог, а не просто использовать текущий каталог, т.е. .).

Answer 2

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

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

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

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

Answer 3

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

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

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