查看源代码 EDoc 发行说明
本文档描述了对 EDoc 应用程序所做的更改。
Edoc 1.3.2
修复的错误和故障
发行说明中损坏的链接已修复。
自身 ID: OTP-19139 辅助 ID: PR-8584
Edoc 1.3.1
修复的错误和故障
修复构建 HTML 文档时损坏的 makefile 依赖项。
自身 ID: OTP-19116 辅助 ID: PR-8534
Edoc 1.3
修复的错误和故障
EEP 48 文档块现在正确地包含
{@type }宏中的链接。自身 ID: OTP-18945 辅助 ID: PR-8063
@hidden现在在 EEP 48 文档块中表示hidden，而不是none。自身 ID: OTP-18946 辅助 ID: PR-8063
改进和新功能
有一个新的
edoc_html_to_markdown模块，可用于将 EEP-48application/html+erlang转换为 Markdown。自身 ID: OTP-18947 辅助 ID: PR-8063
文档已迁移为使用 Markdown 和 ExDoc。
自身 ID: OTP-18955 辅助 ID: PR-8026
添加了模块
edoc_doclet_markdown，可用于将 EDoc 风格的文档转换为 Markdown 文档属性。自身 ID: OTP-19052 辅助 ID: PR-8308
Edoc 1.2.1
修复的错误和故障
发出 <code> 而不是 <tt>。
自身 ID: OTP-18782 辅助 ID: PR-7643
Edoc 1.2
修复的错误和故障
修复内部 edoc 模块中未使用的类型警告。
自身 ID: OTP-17550 辅助 ID: GH-5094 PR-5106
改进和新功能
在生成 EEP-48 风格的文档时，向跳过的标签添加源文件警告。
自身 ID: OTP-17556 辅助 ID: PR-5023
修复文档块生成器，即使没有模块级别的文档，也可以发出文档。
修复文档块生成器，以正确尊重模块和函数的
@hidden和@private标签。自身 ID: OTP-17733 辅助 ID: PR-5205
Edoc 1.1
改进和新功能
添加选项
link_predefined_types，用于创建指向 Erlang 预定义类型的链接。 这主要供 erl_docgen 在创建 Erlang/OTP 文档时使用。自身 ID: OTP-17743 辅助 ID: PR-5292
Edoc 1.0.1
修复的错误和故障
修复 edoc_extract:file/4 中损坏的文档链接。
自身 ID: OTP-17552 辅助 ID: GH-5058
Edoc 1.0
修复的错误和故障
修复 edoc_doclet 选项
file_suffix也影响模块索引中发出的链接。自身 ID: OTP-17092
改进和新功能
Erlang 文档引擎 EDoc 在此版本中达到 1.0 版本，这意味着一些更改。
EDoc 现在能够发出 EEP-48 文档块。 这意味着，通过一些配置，社区项目现在可以像 OTP 库自 OTP 23.0 以来那样为
shell_docs提供文档。@spec和@typeEDoc 标签已被弃用。 新的块生成 doclet 和布局不支持这些。 此外，以前当为同一函数定义了冗余的@spec标签和-spec属性时，@spec标签将优先。 现在，-spec属性优先，并且更重要。 冗余的@type标签和-type属性也是如此。 当发现此类冗余条目时，现在会发出警告。edoc_doclet.hrl中的?NO_APP宏已被弃用。 请改用原子no_app。有关更多详细信息，请参阅 Edoc 用户指南中的文档块章节。
*潜在的不兼容性*
自身 ID: OTP-16949 辅助 ID: PR-2803 OTP-17192
Edoc 已更新为使用
-spec来记录其自己的接口，而不是@doc@标签。除了此更改外，还改进了
-spec样式文档的应用程序间链接。自身 ID: OTP-17095 辅助 ID: PR-2914
允许用户定义的 edoc 宏作为函数。
自身 ID: OTP-17153 辅助 ID: PR-2674
Edoc 0.12
改进和新功能
从 EDoc 中删除 Inets 依赖项。
自身 ID: OTP-15999 辅助 ID: PR-2317
添加对重载 Erlang 规范的支持。
自身 ID: OTP-16407 辅助 ID: PR-2430
重构了已弃用和已删除函数的内部处理。
自身 ID: OTP-16469
Edoc 0.11
改进和新功能
更正文档中的链接。
自身 ID: OTP-15761
Edoc 0.10
改进和新功能
打印有用的消息，解释说如果读取源文件失败，添加
{preprocess, true}可以提供帮助。自身 ID: OTP-15605 辅助 ID: ERL-841
Edoc 0.9.4
修复的错误和故障
改进了文档。
自身 ID: OTP-15190
Edoc 0.9.3
修复的错误和故障
包括
map/0类型的类型和函数规范会正确地漂亮打印。自身 ID: OTP-15117
改进和新功能
更新为使用新的字符串 API 而不是旧的 API。
自身 ID: OTP-15036
Edoc 0.9.2
修复的错误和故障
在函数规范和类型中，映射类型正确地表示为
map/0。自身 ID: OTP-14777
Edoc 0.9.1
改进和新功能
工具已更新，可以正确显示 Unicode 原子。
自身 ID: OTP-14464
Edoc 0.9
改进和新功能
为了支持稳定的构建，
edoc不再在生成文件的页脚中包含时间戳。自身 ID: OTP-14277
由于包含任意 Unicode 字符的原子而进行的杂项更新。
自身 ID: OTP-14285
Edoc 0.8.1
改进和新功能
记录函数标签
@param和@returns。自身 ID: OTP-13930 辅助 ID: PR-1175
Edoc 0.8
改进和新功能
改进从 Erlang 源文件生成的 OTP 文档中的类型和规范。
自身 ID: OTP-13720 辅助 ID: ERL-120
Edoc 0.7.19
改进和新功能
处理类型化的记录字段。
自身 ID: OTP-13558
Edoc 0.7.18
修复的错误和故障
为列表参数分配正确的名称。
自身 ID: OTP-13234 辅助 ID: ERL-63
改进和新功能
除非
sort_functions选项为true，否则edoc_layout不会对函数进行排序。自身 ID：OTP-13302
Edoc 0.7.17
改进和新功能
移除与包相关的功能
自身 ID：OTP-12431
Edoc 0.7.16
修复的 Bug 和故障
映射：在文档中正确对齐联合类型关联值
自身 ID：OTP-12190
Edoc 0.7.15
修复的 Bug 和故障
修复了从 erl_docgen 和 edoc 为映射生成规范到文档的问题
自身 ID：OTP-12058
Edoc 0.7.14
修复的 Bug 和故障
Erlang 源文件的默认编码现在是 UTF-8。作为一项临时措施，以缓解从旧的默认 Latin-1 进行转换，如果 EDoc 遇到不是有效的 UTF-8 序列的字节序列，EDoc 将在 Latin-1 模式下重新尝试。此解决方法将在未来的版本中删除。
自身 ID：OTP-12008
Edoc 0.7.13
修复的 Bug 和故障
以下应用程序的应用程序升级 (appup) 文件已更正
asn1、common_test、compiler、crypto、debugger、dialyzer、edoc、eldap、erl_docgen、et、eunit、gs、hipe、inets、observer、odbc、os_mon、otp_mibs、parsetools、percept、public_key、reltool、runtime_tools、ssh、syntax_tools、test_server、tools、typer、webtool、wx、xmerl一个新的测试实用程序用于测试 appup 文件已添加到 test_server。现在 OTP 中的大多数应用程序都使用它。
(感谢 Tobias Schlager)
自身 ID：OTP-11744
Edoc 0.7.12.1
改进和新功能
notes.xml文件的编码已从 latin1 更改为 utf-8，以避免将来出现合并问题。自身 ID：OTP-11310
Edoc 0.7.12
修复的 Bug 和故障
EDoc 有时无法将注释与前面的类型声明关联。此错误已修复。（感谢 Serge Aleynikov 报告此错误。）
自身 ID：OTP-10866
改进和新功能
由于 Unicode 支持的杂项更新。
自身 ID：OTP-10820
Edoc 0.7.11
改进和新功能
自 EDoc 0.7.7 (R14B02) 起，可以对联合类型的单独值进行注释。但是，由于向后兼容性，解析器迄今为止选择不添加必要的括号。
从本版本开始，遍历
edoc_parser输出的代码需要注意联合类型单独值周围的括号。此类代码的示例是布局模块和 doclet 模块。*潜在的不兼容性*
自身 ID：OTP-10195
已实现对 Unicode 的支持。
自身 ID：OTP-10302
在必要时，已在 Erlang 文件中添加了一条说明编码的注释。此注释旨在在 UTF-8 成为默认编码时在 Erlang/OTP R17B 中删除。
自身 ID：OTP-10630
Edoc 0.7.10
修复的 Bug 和故障
在使用 -callback 属性时在 Edoc 中列出行为回调。（感谢 Magnus Henoch。）
为 Windows 下的文件名添加了特殊情况。（感谢 Beads Land-Trujillo。）
自身 ID：OTP-10174
Edoc 0.7.9.1
改进和新功能
杂项文档构建更新
自身 ID：OTP-9813
Edoc 0.7.9
修复的 Bug 和故障
no_return是一个新的内置类型。自身 ID：OTP-9350
与 edoc 开发版本同步
忘记确保在路径中找到 xmerl 以使 include_lib 工作
修复在 R13B04 中不起作用的 -spec 声明
消除有关未使用导入的警告
从源文件中删除了 CVS 关键字（感谢 Richard Carlsson）
自身 ID：OTP-9463
添加 proplist() 类型
最近我在向 API 添加规范时发现没有定义规范的 proplist() 类型。（感谢 Ryan Zezeski）
自身 ID：OTP-9499
删除了 dialyzer 报告的一些永不匹配的子句修复了 Erlang 类型后的注释中的宏展开始终将 URI 转义字节作为两个十六进制数字 (由 Alfonso De Gregorio 报告) 更新了作者电子邮件识别 wiki 文本中更多的 URI 方案，特别是 https（感谢 Richard Carlsson）
自身 ID：OTP-9590
Edoc 0.7.8
修复的 Bug 和故障
修复了格式错误的 edoc 输入的无限循环
当处理包含 ``` 的 edoc 注释时，如果注释在结尾处没有匹配的 '''，则函数 edoc_wiki:strip_empty_lines/2 中会发生无限循环。此更改通过添加一个子句来解决此问题，以便在注释输入结束时从函数返回。这允许抛出错误来指示问题，这与留下未匹配的 `` 或 ` 的行为相同。（感谢 Taylor Venable）
自身 ID：OTP-9165
已更正有关在 EDoc-0.7.7 中添加的选项
report_missing_types的错误：该选项在源代码中拼写错误，并且本地定义以及函数标签@private和@hidden未得到正确处理。（感谢 Manolis Papadakis。）自身 ID：OTP-9301
Edoc 0.7.7
修复的 Bug 和故障
在解析 Wiki 文本时添加编码。EDoc 过去常常在诸如 "äåö" 之类的字符串上失败。（感谢 Richard Carlsson。）
自身 ID：OTP-9109
改进和新功能
现在可以在 EDoc 文档中使用 Erlang 规范和类型。除非也有一个同名的函数规范 (
@spec) 或类型别名 (@type)，否则将使用 Erlang 规范和类型。在当前的实现中，-spec的位置很重要：它应该放在@spec原本应该放置的位置。并非所有 Erlang 类型都包含在文档中，而仅包含那些由某些
export_type声明导出或由某些文档化的 Erlang 规范 (-spec) 使用的类型。目前不支持重载的 Erlang 规范。
EDoc 的语法定义已得到增强，以处理大多数 Erlang 类型。（但我们建议应使用 Erlang 类型。）
edoc:read_source()采用一个新选项report_missing_types。edoc_layout:module()采用一个新选项pretty_printer。自身 ID：OTP-8525
edoc_lib模块是私有的，但由于其他手册页引用了它，因此已包含在 OTP 文档中。此工单中引入的修改使所有函数都是私有的，除了其他页面引用的函数之外。自身 ID：OTP-9110
Edoc 0.7.6.8
改进和新功能
消除了编译器警告。
自身 ID：OTP-8855
Edoc 0.7.6.7
修复的 Bug 和故障
Edoc 现在使用新的 API 函数来
inets而不是已弃用的函数。自身 ID：OTP-8749
Edoc 0.7.6.6
改进和新功能
在修复了许多 Bug 并向文档构建过程添加了一些功能后，现在可以在开源环境中构建文档。
- 更新了元数计算。
- 在生成的链接中，bif 的函数名中使用的模块前缀被移除，因此链接将类似于 "https://erlang.org.cn/doc/man/erlang.html#append_element-2"" 而不是 "https://erlang.org.cn/doc/man/erlang.html#erlang:append_element-2""。
- 增强了在加载新页面时 HTML 文档中的菜单定位。
- 对 man 页面的生成进行了一些修正（感谢 Sergei Golovan）。
- 法律声明取自 XML 书籍文件，因此 OTP 的构建过程可以用于非 OTP 应用程序。
自身 ID：OTP-8343
Edoc 0.7.6.5
改进和新特性
文档现在使用大多数平台上都存在的开源工具（xsltproc 和 fop）构建。一个明显的变化是框架被移除。
自身 ID：OTP-8201
Edoc 0.7.6.4
改进和新特性
杂项更新。
自身 ID：OTP-8190
Edoc 0.7.6.3
改进和新特性
版权声明已更新。
自身 ID：OTP-7851
Edoc 0.7.6.2
改进和新特性
小更新。
自身 ID：OTP-7642
Edoc 0.7.6.1
已修复的错误和故障
修正了与不再具有
erl_internal:obsolete/3函数的新版本 STDLIB 的兼容性问题。自身 ID：OTP-7539
Edoc 0.7.6
改进和新特性
小改动。
自身 ID：OTP-7388
Edoc 0.7.5
改进和新特性
小更新，主要是外观上的。
自身 ID：OTP-7243
Edoc 0.7.3
改进和新特性
Makefile 的小改动。
自身 ID：OTP-6689
消除了 Dialyzer 警告。
自身 ID：OTP-6737
EDoc 0.7.2
已修复的错误和故障
添加了一些缺失的文件：
~/include/edoc_doclet.hrl，~/priv/edoc.dtd，~/priv/erlang.png自身 ID：OTP-6457
改进和新特性
- 未定义的宏只会导致警告，不会导致错误。
- 新的内置
@version宏。 - 记录了
@docfile和@headerfile通用标签。 - 添加了对
"TODO:"的识别，作为@todo标签的 wiki 等效项。 - 添加了关于概述页面的文档。
'where'和','允许作为 spec 中的分隔符。- 修正了 spec 语法中的歧义（可能的不兼容问题 - 在某些情况下，现有代码中可能需要添加括号）。
- 实验性的（且未记录的）支持
@param和@return标签，以及@spec参数上相应的"..."注释。
*潜在的不兼容性*
自身 ID：OTP-6568
EDoc 0.7.1
已修复的错误和故障
修复了文档中的一些损坏的链接。
自身 ID：OTP-6419
EDoc 0.7.0
杂项更改。