cakephp / cakephp/cakephp-api-docs
API Docs Links appear broken
未关闭
还没有人认领这个 Issue。
- 主要语言
- PHP
- 星标
- 29
- 派生
- 15
- PR 合并指标
- 30 天内没有已合并 PR
描述
Description
Viewing API Documentation on the web, e.g. RecordNotFoundException, shows the raw link string instead of an actual hyperlink, e.g.:
Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}
It doesn't seem that the files containing the links are the issue, e.g. CakeException.php hasn't changed in ~two years, perhaps the docs builder/link generator has started failing?
CakePHP Version
4.4.0
PHP Version
No response
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
将生成的 RecordNotFoundException API 页面与 CakeException.php 中的源引用进行比较,尤其是 {@link \Cake\Http\Response::withHeader()} 文本。追踪负责转换这些引用的文档构建器或链接生成器,然后验证生成的 API 文档是否将它们渲染为超链接,而不是原始字符串。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- php
- 领域
- documentation
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100