为 XCODE 项目生成 Apple Docs答案

【问题标题】：Generate Apple Docs for XCODE project为 XCODE 项目生成 Apple Docs
【发布时间】：2013-08-06 01:32:52
【问题描述】：

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

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.

感谢任何帮助。

【问题讨论】：

标签： objective-c macos headerdoc

【解决方案1】：

我有同样的问题。我通过全部更改来修复它

/// Comments

和

/**
 * Comments
 */

/*!
 * Comments
 */

对我来说一切都很好。

【讨论】：

有没有办法让HeaderDoc理解上面cmets的风格？

【解决方案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）

【讨论】：

【解决方案3】：

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

headerdoc2html -j -o OutputDirectory InputDirectory

【讨论】：

我在 OSX 中无法使用 -j 选项