问题标签 [docc]

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 投票
0 回答
46 浏览

xcode13 - 使用 Apple DocC 时:如何不生成文档?如何链接到 UIKit?如何为扩展生成文档?

我是第一次使用 DocC,在阅读了您的文档后,有 4 件事我不知道该怎么做,您能帮帮我吗?

如何标记公共方法以告诉 DocC 我不想为特定方法生成文档?例如,我有一个CaruselView,它是 的子类UIView。这个子类正在覆盖方法layoutSubviews。DocC 正在生成空文档。不大好。在使用 Jazz(另一个文档系统)时,我可以使用:

但是,DocC 中的等价物是什么?

UIView我添加到, UIColor, ...的所有公共方法UILabel使用扩展名和文件,例如"UIView+Extensions.swift,在我按下Generate DocumentationXcode 后,它们不会出现在生成的文档中。这是 DocC 限制还是错误?我的意思是,我看到了类、枚举、结构的部分......但没有关于 UIKit 类/结构的扩展。

除此之外,如果我的结构或类之一引用这些方法之一(在扩展文件中),我不知道创建链接的语法。例如,这不起作用:

我该怎么做?由于我之前的问题,我想我无法链接不存在的东西。

最后一个问题,使用双引号我们可以在我们的包/框架中引用符号。这工作正常。但是我们如何链接来自UIKit其他 Apple 框架或其他 Apple 框架的符号呢?例如:

如果我使用

这没用。我应该使用什么格式?

非常感谢您的建议。

0 投票
0 回答
21 浏览

xcode - DocC 索引在使用 MAMP 时显示空白页

我正在尝试为我工作的公司执行 POC,以了解在我们的项目中使用 DocC 可以获得的潜在价值。

在我开发之前,我看过 WWDC 2021 中与 DocC 相关的 4 个视频,访问Apple 开发者网站并阅读一些页面和博客以收集一些信息和想法。

对于我的开发,在将工作推送到服务器之前,我开始在我的开发机器上使用 MAMP。

到目前为止,我认为我已经完成了在网站上托管文档档案的所有必要步骤。但是,我想知道我是否错过了一些东西,因为我的 index.html 看起来是空白的。

我使用的代码是:

index.html(主要)

.htaccess

文件结构

在此处输入图像描述

图片证明doccarchive不是空的

在此处输入图像描述

空白页图片

在此处输入图像描述

有任何想法吗??

0 投票
0 回答
30 浏览

xcode - DocC - 500 错误 - 无法加载 http://localhost:8888/data/documentation/index.html.json

我正在使用 MAMP(在发布之前)尝试将我的PrintMyName.doccarchive框架的内容托管到我的网站中。

据我所知,我已遵循文档中描述的所有步骤:

导出文档存档 在此处输入图像描述

将文档存档添加到我的根文件夹中 在此处输入图像描述

创建并修改了 .htaccess 模板以匹配我的文档存档的名称

将代码添加到我的主 index.html

在此处输入图像描述

当我单击按钮时,问题就出现了。我看到 htaccess 正在工作,但是在为我的文档加载内容时,我确实看到了以下错误:

错误 在此处输入图像描述

我确实想象在尝试映射/重写时出现了一些问题(请原谅我对服务器术语的了解不足),因为 index.html.json 显然不存在:

在此处输入图像描述

地图(再次抱歉)是否试图将出现的PrintMyName替换为index.html???

有什么想法吗?

0 投票
0 回答
27 浏览

ios - 如何从 xcode 文档中的另一个模块/包链接到文档?

我正在尝试在我的 xcode 文档中创建文章。我的项目有多个模块。

对于一个模块中的文章链接,我有文档:标记。但我不明白,如何从另一个模块链接到文章。

我尝试使用:

但所有这些都不起作用。

0 投票
1 回答
79 浏览

ios - 如何使用 Docc 在 GitHub 上发布?

我有一个 SPM 包托管在https://github.com/janodev/foobar.

如何使用 Docc 生成文档并将其托管在 GitHub 上?