Создание документов Apple для проекта XCODE

Question

Я пытаюсь сгенерировать документы Apple для одного из моих проектов. Я использую следующие команды для генерации документов...

headerdoc2html -o OutPutDirectory InputDirectory

Я получаю следующее сообщение...

Processing /Users/Ankit/Documents/Projects/pos/trunk/TestProject/TestProject/Test.h
    Skipping. No HeaderDoc comments found.
No default encoding.  Guessing.  If date formats are wrong, try
specifying an appropriate value in the LANG environment variable.

Любая помощь приветствуется.

Answer 1

У меня была такая же проблема. Я исправил это, изменив все

/// Comments

А также

/**
 * Comments
 */ 

Комментарии к

/*!
 * Comments
 */

И у меня все работало нормально.

Answer 2

Переменная среды LANG не установлена ​​ни в каком месте, куда может обратиться ваш Xcode. Возможно, потому что это не было установлено в ваших настройках сборки.

Выполнение команды ниже напечатает все переменные окружения, LANG не будет среди них.

xcodebuild -project Path/To/Your.xcodeproj -target "YourTarget" -showBuildSettings

Переменные среды управляются в ваших схемах в таблице "Переменные среды", но мне не повезло, что они менялись там. В конечном итоге я сделал (поскольку мой вызов headerdoc2html был в сценарии сборки в моих этапах сборки моей цели документации), я добавил эту строку в начало моего сценария bash:

export LANG=en_US.US-ASCII

Сообщение ушло после этого.

Мой общий сценарий, для любопытных.

export LANG=en_US.US-ASCII
/Applications/Xcode.app/Contents/Developer/usr/bin/headerdoc2html -o ~/Development/Path/To/My/Documentation ~/Development/Path/To/My/Project/Headers
/Applications/Xcode.app/Contents/Developer/usr/bin/gatherheaderdoc ~/Development/Path/To/My/Documentation

(Версия Xcode 4.6.3)

Answer 3

Вы также можете использовать флаг -j, чтобы включить синтаксис Javadoc, и вам не придется изменять какой-либо код вашей документации.

headerdoc2html -j -o OutputDirectory InputDirectory