问题标签 [appledoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
986 浏览

ios - Appledoc 和自定义链接描述

如果我做了一些愚蠢的事情,我会提前道歉。但我无法确定我的错误。

这是代码(头文件):

结果:

在此处输入图像描述

我正在遵循这些说明(在“自定义链接描述”部分)。

我也试过:

也许 Xcode 弄乱了文件?关于第二个相关问题,您知道是否有办法阻止 Xcode 在其编辑器中自动创建链接?(我的意思是将字体颜色更改为蓝色并加下划线)。

提前致谢。

0 投票
1 回答
322 浏览

github - 使用 appledoc 在 GitHub 项目上添加文档

我注意到 GitHub 上的一些项目有使用 Appledoc 创建并托管在 username.github.com/project/Documentation 的文档页面。例如:

项目:http://pandamonia.github.com/BlocksKit/
文档: http: //pandamonia.github.com/BlocksKit/Documentation/

这是如何运作的?有没有办法为我自己的项目做到这一点?

0 投票
1 回答
146 浏览

documentation - appledoc 中的宏或动态占位符

在我的 iOS 项目中,我在一些类的文档中添加了截图图像。
该文档是使用appledoc生成的。

基本上,对于 class TheViewController,这看起来像这样:


有什么办法可以干燥这个吗?
一个宏,预处理(通过preprocess-headerdoc?),动态占位符,脚本,提供给appledoc的选项?

理想情况下,我只想拥有这个:




如果我什至不必添加 line SCREENSHOTS_FOR_IPAD_AND_IPHONE,则奖励积分,并且仅在满足某些条件时才添加内容(即,如果在预期的位置找到图像)。

0 投票
0 回答
1258 浏览

objective-c - 有没有办法在 AppCode 中使用 appledoc 生成文档?

或者有什么办法(使用其他文档生成器)让它在 AppCode 中工作?

0 投票
2 回答
526 浏览

in-app-purchase - 应用购买中的 AutoRenewable 订阅没有免费试用

根据苹果开发者资源中的应用内购买指南,它明确表示我们可以提供免费试用选项。 在 Apple Developer Docs 的 App Purchases Guide 表 12-5 中。

但是当我在 iTunesConnect 中设置应用购买时,我无法在任何地方看到它。他们还在提供吗?我在哪里可以找到它?

这是我在 iTunesConnect 中看到的屏幕截图 在此处输入图像描述

0 投票
1 回答
357 浏览

xcode - AppleDoc 类别未显示在快速帮助中

我已经按照安装说明成功地使用 AppleDoc 生成了一个文档集。如果我进入 XCode Documentation Organizer,一切都在那里,包括类别:

在此处输入图像描述

但是当我⌥</kbd>-click on one of my category methods I see nothing but this:

在此处输入图像描述

我已经尝试了很多东西,但这些都不起作用:

  • 添加 --no-merge-categories
  • 添加--merge-categories
  • 更改文件扩展名
  • 重启 XCode
  • 重启macbook
  • 搜索 google(AppleDoc 快速帮助类别)
  • 搜索堆栈溢出
  • 搜索 gitHub 仓库问题列表(https://github.com/tomaz/appledoc

请帮忙,因为我想生成文档,而且我的大部分库都包含类别。我正在使用最新的 AppleDoc(appledoc 2.1(build 858))和 Xcode 4.6.3。

编辑:是否有用户实际使用 AppleDoc?快速帮助真的对你有用吗?我还注意到即使存储库定期更新,也缺少文档。

0 投票
1 回答
928 浏览

ios - Appledoc 例外:至少需要一个目录或文件名路径

当我输入上面的命令时,出现错误:

至少需要一个目录或文件名路径,使用 ' appledoc --help'

gogopiao_v2是我项目的根目录。希望有人可以帮助我解决这个问题。

0 投票
1 回答
276 浏览

protocols - 如何使用 appledoc 记录内联协议

我已经定义了一个Objective-C @class,它在@interface 之前的标题中定义了一个@protocol 内联。

我无法让 appledoc 为协议生成文档。是否可以内联或协议是否需要是一个单独的文件?

0 投票
1 回答
494 浏览

ios - 为什么 Appledoc 对输入参数类的引用没有突出显示?

Apple 文档有输入参数的交叉引用。您可以看到NSStringEncodingNSError突出显示:在此处输入图像描述

但是当我使用appledoc时,根本没有交叉引用:在此处输入图像描述

这是我的配置文件:

怎么了?

0 投票
1 回答
439 浏览

ios - 如何在 xcode 构建阶段运行脚本中检查 appledoc 是否有效?

如您所知,我们可以为 xcode 构建阶段运行脚本编写一个 sh 脚本;并且我希望它仅在发布版本的项目和已安装软件 appledoc 时运行,所以我将其编写如下:

它似乎根本不起作用!我知道问题是命令“哪个appledoc”出错了!所以问题是: