问题标签 [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 投票
1 回答
461 浏览

xcode - 在没有 Apache Server/ (.htaccess) 的情况下运行 Xcode DocC

在 DocC 文档“向外部开发人员分发文档”中,Apple 提供了在您的网站上托管文档存档的文档。不幸的是,当我打开时.doccarchive/index.html,我只得到一个白页。他们只展示了 Apache 服务器的指南。他们指定了使用.htaccess文件,并RewriteRule .* SlothCreator.doccarchive/$0 [L]在用户访问文档页面时使用重写 URL。

有没有办法在不运行 Apache 服务器的情况下打开文档 Web 应用程序?(我不想做任何机器特定的配置,比如修改/etc/hosts)。能够将其托管为静态站点(例如在 Github 页面、Cloudflare 页面、Netlify 等)上将是理想的

编辑:使用@Ranoiaetep 的答案,我已经构建并将其推送到GitHub存储库,并且可以通过 Netlify 站点查看:https ://xcode-docc.netlify.app/documentation/

0 投票
1 回答
152 浏览

swift - 在 macOS 上通过 Apache 本地运行 Xcode DocC 文档

Xcode 13 的 DocC 文档存档可以使用自定义 Apache.htaccess文件进行托管,如向外部开发人员分发文档托管和自动化您的 DocC 文档 - WWDC21中所述。

在 macOS / M1 Mac 上为SlothCreator示例项目进行设置的步骤是什么,以便您可以在浏览器中查看文档?

0 投票
2 回答
74 浏览

swift - 将 Apple DocC 作为 Apple 帮助手册文件运行

随着用于从源代码生成文档的 DocC 的引入,是否可以获取 DocC 的输出并将其用作 Apple 帮助手册(用于 macOS 应用程序内部)的真实来源?

0 投票
1 回答
165 浏览

ios - 如何在 Apple DocC 上添加字符串扩展

我正在检查新的 Apple 文档Xcode 13 beta。我可以build documentation使用 DocC。

但我看不到为字符串扩展、日期扩展等扩展创建的任何文档。

根据以下情况的示例,它不会添加任何文档。

考虑一下,如果我为任何结构或类创建了扩展,那么它将添加如下代码的文档

这是苹果的默认行为还是我遗漏了什么?

0 投票
0 回答
31 浏览

swift - DocC 中针对不同平台的条件指令

使用 DocC 来记录一个 swift 包,有没有办法根据你是为 iOS 还是 macOS 编译条件部分?

我的问题如下;在一个包中,我有一个仅在 macOS 上有效的符号。如果我在 DocC 文章中引用该符号(使用 ``Symbol``),我会在为 iOS 编译时收到警告(“主题引用‘符号’无法解析为已知文档”)。

没什么大不了的,但我讨厌留下警告......

编辑:此外,警告会传播到使用该包的所有应用程序...

0 投票
0 回答
23 浏览

xampp - 如何使用 XAMPP 打开文档存档

我使用Xcode13构建文档存档。

当它直接位于htdocs使用以下网址的目录中时,我可以打开

下面是我的.htaccess文件

如果我想把它放在 的任何子文件夹中htdocs,它不工作,它的显示如下:

0 投票
1 回答
116 浏览

xcode - 如何从 CLI 构建 DocC 文档

因此,我已经浏览了一段时间的网络,似乎无法找到有关如何使用 CLI 命令构建本机 DocC Xcode 文档 的答案。

据我所知,xcodebuild命令和 Fastlane 都没有提供构建文档的命令。

这些文档应该构建在 CI/CD Github Actions 工作流中。如果有其他方法可以做到这一点,任何帮助表示赞赏。

0 投票
0 回答
36 浏览

ios - DocC 文档无法在 CentOS 7 上使用 Apache 呈现

我从这里下载了示例代码项目“SlothCreator”,然后导出了一个 SlothCreator.doccarchive 文件。

我将 SlothCreator.doccarchive 放在 /var/www/html/ 中。

我的 .htaccess 文件如下。

我确认 RewriteEngine 运行良好。

我尝试以下网址,然后看到错误消息“发生未知错误”。或“找不到您要查找的页面。”

CentOS 上的 Apache 访问日志:GET /data/documentation/SlothCreator.json HTTP/1.1" 500

我能知道问题是什么吗?

我在 CentOS 7 上使用 Apache Web 服务器。.doccarchive 不能在 CentOS 上工作吗?我确认 .doccarchive 在 Mac 上运行良好。

(我也在这里留下了这个问题。)

谢谢你的帮助

0 投票
0 回答
19 浏览

ios - 如何将我的 xocde 项目转换为 xcode 包?

我有一个带有 swift 类和 pod 的常规 xcode 项目。我需要为项目生成文档。但是,我知道 xcode 13 内置文档生成器 (DocC)(产品 -> 构建文档)仅支持 xcode 框架和包的文档。因此,我需要将我的项目转换为 xcode 包。我该怎么做?(我是 iOS 开发新手)

0 投票
0 回答
22 浏览

ios - Xcode 框架中的混合语言文档生成

我在 Xcode 中创建了一个示例目标 c 框架,我还创建了一个 swift 文件。这是显示一个 swift 文件和另一个目标 c 类 (NewFramework) 的导航控制器。

当我尝试为框架构建文档时,我只会获得 swift 文件的文档,而不是目标 c 类的文档。这是 ObjcTemp.h 文件内容:

这是 ObjcTemp.m 文件内容:

我使用了默认的 xcode 13 文档工具 (DocC)。 构建文档

生成的文档存档如下所示:. 在此处输入图像描述

我想使用 Default Xcode 文档工具为目标 c 和 swift 文件生成完整的文档。我怎样才能做到这一点 ?