爲XCODE項目生成Apple文檔

我正在嘗試爲我的一個項目生成蘋果文檔。我使用下面的命令來生成文檔...爲XCODE項目生成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.

任何幫助表示讚賞。

來源

2013-08-05 Ankit Srivastava

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）

來源

2013-09-06 12:06:34 Andrew

我有同樣的問題。我固定它通過改變所有

/// Comments

而且

/** 
* Comments 
*/

意見

/*! 
* Comments 
*/

所有的一切都爲我工作得很好。

來源

2014-12-24 00:21:52

謝謝!!這對我有效。 –

有沒有辦法讓HeaderDoc瞭解上面的註釋風格？ –

您還可以使用-j標誌來啓用javadoc語法，而不必更改任何文檔代碼。

headerdoc2html -j -o OutputDirectory InputDirectory

來源

2015-07-09 14:41:53 Mohammad

OSX capitan中的-j選項不適用於我 –

爲XCODE項目生成Apple文檔

回答

相關問題