为XCODE项目生成Apple Docs

时间:2013-08-05 10:59:54

标签: objective-c macos headerdoc

我正在尝试为我的一个项目生成苹果文档。我使用以下命令生成文档...

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.

感谢任何帮助。

3 个答案:

答案 0 :(得分:4)

我有同样的问题。我通过改变所有

来修复它
/// Comments

/**
 * Comments
 */ 

的评论
/*!
 * Comments
 */

一切都适合我。

答案 1 :(得分:3)

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)

答案 2 :(得分:0)

您还可以使用-j标志启用javadoc语法,而不必更改任何文档代码。

headerdoc2html -j -o OutputDirectory InputDirectory