问题标签 [appledoc]

我编写了一个简单的可重用控件，并在寻找一种记录其功能和属性的方法时，我发现了这个有用的工具——appledoc。

我创建了一个演示项目来展示我的控件的功能。现在，当我使用 appledoc 生成文档时，它也为演示类创建了引用。我不想要这个。我期望 appledoc 仅为我的可重用类生成文档。我怎么能那样做？

我的脚本是这样的：

尝试在 --ignore 标记中添加我的AppDelegate和ViewController类，但它似乎不起作用。我在这里有什么遗漏吗？

我-startMonitoringSignificantLocationChanges在我的应用程序中使用。

后台应用

- (void) locationManager:(CLLocationManager *)manager didUpdateToLocation:(CLLocation *)newLocation fromLocation:(CLLocation *)oldLocation

方法调用。我想在 didUpdateToLocation 中调用 API（当应用程序在后台时）。当位置发生重大变化时调用上述方法。在那个方法中，我调用了我的 API。所有这一切都发生在后台，一切都很好。我想知道可以吗？我对苹果文档没有好主意。我认为这种方法苹果不会拒绝。任何人请给我一些想法。

谢谢

有人可以在记录我的 typedef NS_ENUM 时解释我做错了什么吗？

这是我的语法：

我的运行脚本构建阶段：

结果：

并构建结果：

从终端：

我似乎无法弄清楚。

提前致谢！

我希望这不是重复的，但是在浏览了其他问题之后，我认为它可以提出我在 Appledoc 2.2-963 中遇到的几个问题。我使用 brew 安装，效果很好，Apple doc 一直在为我生成很棒的文档，但我觉得每次运行时软件段都会出错和中断，这对我来说是错误的。下面是我用来在我的工作目录中运行带有项目文件的 appledoc 的脚本。

此外，我正在使用此处找到的 VVDocumenter：https ://github.com/onevcat/VVDocumenter-Xcode 。

一切似乎都很好，但是我得到了一些错误。分段错误：11，另一个错误是出了点问题。（无法为这个快速问题重现它）。无论如何，你明白了。每次使用都会崩溃。

这也是我使用 VV 进行记录的示例

我想我的问题是，即使它工作了一半，我这样做是否正确？还有一种方法可以在我的工作目录中将文档生成为 html，以便我也可以将其推送到 github（或者这不是一个好习惯）？我只是想学习这一点，除了提供的 --help 选项和一些非常低于 IMO 的博客之外，似乎很少有好的使用示例。

无论如何，非常感谢其他人发现这篇文章有帮助，因为我确实知道其他人看到过类似的问题但只是放弃了，我认为这是一个用户错误。

——迈克尔·巴蒂斯特

编辑：

另外我忘了提到这也是说我的所有课程都没有记录，例如上面提供的示例。这是因为我没有完成或其他事情，或者我做错了。

啊.. 最后一件事是有一种方法可以将基础类也链接到文档中。例如在函数中使用 NSArray 并将 NSArray 链接到主文档集。

再次感谢。

编辑：2014 年 4 月 7 日

这是一个典型的崩溃报告。

如何指示Appledoc注释中的内联代码块？this

反引号只是在 Xcode 快速帮助面板中读作反引号。

我真的很想以NSStringFromClass某种方式编纂。

我想这样描述我的代码

但是当我尝试使用 loadXML 的快速帮助时：Xcode 崩溃并出现此错误：

有人可以帮我吗？

对不起，我的英语不好

在课堂上，我有以下方法和评论：

这个注释可以在 Xcode 的 Quick Help 中看到，效果很好。

但是，我想在第二个注释行中创建一个指向 GSDContentLayer 的链接，这样当我单击“快速帮助”窗口上的“GSDContentLayer”时，它会直接将我带到包含 GSDContentLayer 类的 .h 文件。

那可能吗？如果是这样，怎么做？

我正在开发一个使用 AppleDoc 生成文档的项目。我想在我的代码中添加一些 TODO 注释，例如：

问题是，当我尝试生成我的项目文档时，我收到了这些麻烦的警告：

/Users/Me/trunk/MyProject/MyProject/src/MyClass.m:119：MyClass.m@119：-[MyClass myMethod:] 缺少参数“myParam”的描述

显然，我可以摆脱我的 TODO 评论，但我想将它们与我美丽的文档一起保留。有人知道如何实现吗？

我们正在开展几个内部项目。我们希望将所有文档保存在同一个地方。我们将 appledocs 用于代码文档。但是我们需要一些页面（比如苹果有他们的配套指南），我们希望将它们与相同的文档捆绑在一起。appledocs可以做到这一点吗？如果是这样，如何？

因此，我正在关注本教程的 appledoc 生成（http://objcsharp.wordpress.com/2013/09/24/how-to-generate-beautiful-apple-style-documentation-in-xcode-5/）。构建后没有任何反应。这是脚本：

为了确保我正确安装了appledoc，我从终端执行了以下操作，并且文档显示正常。

我错过了 Xcode 中的任何关键步骤或设置吗？似乎以下部分没有正确执行，这就是终止此运行脚本的原因：