檢視原始碼 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
和@type
EDoc 標籤已遭棄用。新的區塊產生 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,而不是舊的。
自有 ID:OTP-15036
Edoc 0.9.2
修正的錯誤和故障
在函式規格和類型中,map 類型會正確標示為
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
已修正的錯誤和故障
Maps:在文件中正確對齊 union 型別的關聯值
自有 ID:OTP-12190
Edoc 0.7.15
已修正的錯誤和故障
修正從 erl_docgen 和 edoc 針對映射 (maps) 的規格到文件生成
自有 ID:OTP-12058
Edoc 0.7.14
已修正的錯誤和故障
Erlang 原始檔的預設編碼現在為 UTF-8。作為暫時性措施,以緩和從舊的 Latin-1 預設值轉換的過程,如果 EDoc 遇到非有效的 UTF-8 序列的位元組序列,EDoc 將會以 Latin-1 模式重新嘗試。此變通方法將在未來的版本中移除。
自有 ID:OTP-12008
Edoc 0.7.13
已修正的錯誤和故障
針對下列應用程式修正了應用程式升級 (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
已修正的錯誤和故障
EDoc 有時無法將註解與前面的型別宣告相關聯。此錯誤已修正。(感謝 Serge Aleynikov 回報此錯誤。)
自有 ID:OTP-10866
改進和新功能
由於 Unicode 支援所做的其他更新。
自有 ID:OTP-10820
Edoc 0.7.11
改進和新功能
自 EDoc 0.7.7 (R14B02) 起,可以註釋 union 型別的個別值。然而,由於向後相容性,解析器迄今為止選擇不加入必要的括號。
從此版本開始,遍歷
edoc_parser
輸出結果的程式碼需要注意 union 型別的個別值周圍的括號。此類程式碼的範例有版面配置模組和 doclet 模組。*潛在不相容性*
自有 ID:OTP-10195
已實作 Unicode 的支援。
自有 ID:OTP-10302
在必要時,已在 Erlang 檔案中加入註解說明編碼。此註解的目的在於在 UTF-8 成為預設編碼時,於 Erlang/OTP R17B 中移除。
自有 ID:OTP-10630
Edoc 0.7.10
已修正的錯誤和故障
當使用 -callback 屬性時,Edoc 中的列表行為回呼。(感謝 Magnus Henoch。)
為 Windows 下的檔案名稱新增特殊情況。(感謝 Beads Land-Trujillo。)
自有 ID:OTP-10174
Edoc 0.7.9.1
改進和新功能
其他文件建置更新
自有 ID:OTP-9813
Edoc 0.7.9
已修正的錯誤和故障
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
已修正的錯誤和故障
修正格式錯誤的 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
已修正的錯誤和故障
在剖析 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
模組旨在設為私有,但由於其他 man 頁面會參照它,因此它已包含在 OTP 文件中。在此票證中引入的修改會將所有函數設為私有,但其他頁面參照的函數除外。自有 ID:OTP-9110
Edoc 0.7.6.8
改進和新功能
消除了編譯器警告。
自有 ID:OTP-8855
Edoc 0.7.6.7
已修正的錯誤和故障
Edoc 現在使用新的 API 函數來處理
inets
,而不是已棄用的函數。自有 ID:OTP-8749
Edoc 0.7.6.6
改進與新功能
在修復一些錯誤並在文件建置過程中新增一些功能後,現在可以在開放原始碼環境中建置文件。
- 更新了元數計算。
- 在產生的連結中,為 BIF (Built-in Function) 函式名稱所使用的模組前綴已移除,因此連結將會看起來像 "https://erlang.dev.org.tw/doc/man/erlang.html#append_element-2"",而不是 "https://erlang.dev.org.tw/doc/man/erlang.html#erlang:append_element-2""。
- 當載入新頁面時,增強了 HTML 文件中的選單定位。
- 在 man page 的產生過程中進行了一些修正(感謝 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'
和','
允許作為規格中的分隔符號。- 修正了規格語法中的歧義(可能存在不相容問題 - 在某些情況下,現有程式碼可能需要新增括號)。
- 實驗性(且未記錄)支援
@param
和@return
標籤以及@spec
參數上對應的"..."
註解。
*潛在不相容性*
自有 ID: OTP-6568
EDoc 0.7.1
修復的錯誤與故障
修正了文件中一些損壞的連結。
自有 ID: OTP-6419
EDoc 0.7.0
其他變更。