File 0948-erl_docgen-Add-name-anchors-to-doc-chunks.... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0948-erl_docgen-Add-name-anchors-to-doc-chunks.patch of Package erlang (Revision a348a67ba66c7a948f8268ea2bae17d0)

Currently displaying revision a348a67ba66c7a948f8268ea2bae17d0 , Show latest

From 4cc96273443abfeb0831bfa5849746c0a6a340a9 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Mon, 9 Oct 2023 15:58:52 +0200
Subject: [PATCH 08/13] erl_docgen: Add <name> anchors to doc chunks

---
 lib/erl_docgen/src/docgen_xml_to_chunk.erl | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/lib/erl_docgen/src/docgen_xml_to_chunk.erl b/lib/erl_docgen/src/docgen_xml_to_chunk.erl
index 348dd46b33..c3188d4628 100644
--- a/lib/erl_docgen/src/docgen_xml_to_chunk.erl
+++ b/lib/erl_docgen/src/docgen_xml_to_chunk.erl
@@ -43,7 +43,7 @@ main([_Application, FromBeam, _Escript, ToChunk]) ->
     ok = file:write_file(ToChunk, term_to_binary(EmptyDocs,[compressed])),
     ok;
 main([Application, FromXML, FromBeam, Escript, ToChunk]) ->
-    _ = erlang:process_flag(max_heap_size,20 * 1000 * 1000),
+    _ = erlang:process_flag(max_heap_size,40 * 1000 * 1000),
     case docs(Application, FromXML, FromBeam) of
         {error, not_erlref} ->
             %% The XML files was not a erlref, so we generate
@@ -215,7 +215,9 @@ build_dom({characters, String},
                 {"&plusmn;",[177]},
                 {"&ouml;","ö"},
                 {"&auml;","ä"},
-                {"&aring;","å"}
+                {"&aring;","å"},
+                {"&eacute;","é"},
+                {"&shy;",[173]}
                ],
 
     NoHtmlEnt =
@@ -365,6 +367,10 @@ transform([{anno,[],Content}|T],Acc) ->
     transform([Content|T],Acc);
 
 %% transform <c> to <code>
+transform([{c,[],[{See,Attr,Content}]}|T],Acc)
+  when See =:= seemfa; See =:= seeerl; See =:= seetype; See =:= seeapp;
+       See =:= seecom; See =:= seecref; See =:= seefile; See =:= seeguide ->
+    transform([{See,Attr,[{c,[],Content}]}|T],Acc);
 transform([{c,[],Content}|T],Acc) ->
     transform(T, [{code,[],transform(Content,[])}|Acc]);
 
@@ -570,6 +576,10 @@ func2func({func,Attr,Contents}) ->
                                       lists:join(",",lists:usort(Sinces))) }
         end,
 
+    NameAnchors =
+        lists:flatten([unicode:characters_to_binary(proplists:get_value(anchor,FAttr,[])) || {name,FAttr,[]} <- NameList]),
+    Anchors = [{a,[{id,Anchor}],[]} || Anchor <- NameAnchors, Anchor =/= <<>>],
+
     Functions =
         case NameList of
             [{name,_,[]}|_] ->
@@ -599,7 +609,7 @@ func2func({func,Attr,Contents}) ->
                                     Doc}
                            end,
 
-                Base = MakeFunc(hd(SortedFAs), SinceMD, ContentsNoName),
+                Base = MakeFunc(hd(SortedFAs), SinceMD, Anchors ++ ContentsNoName),
 
                 {BaseF,BaseA} = hd(SortedFAs),
                 MD = SinceMD#{ equiv => {function,list_to_atom(BaseF),list_to_integer(BaseA)}},
@@ -629,7 +639,7 @@ func2func({func,Attr,Contents}) ->
                 Base = {function,[{name,BaseF},{arity,BaseA},
                                   {signature,BaseSig},
                                   {meta,SinceMD}],
-                        ContentsNoName},
+                        Anchors ++ ContentsNoName},
 
                 Equiv = [{function,
                           [{name,F},{arity,A},
-- 
2.35.3

Places

File 0948-erl_docgen-Add-name-anchors-to-doc-chunks.patch of Package erlang (Revision a348a67ba66c7a948f8268ea2bae17d0)

Places