File 2442-Improve-compile-forms-2-documentation.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2442-Improve-compile-forms-2-documentation.patch of Package erlang

From e49b4f6ed090e1578d1a38a2bc6e575fca7da42f Mon Sep 17 00:00:00 2001
From: "Paulo F. Oliveira" <paulo.ferraz.oliveira@gmail.com>
Date: Fri, 30 Oct 2020 00:25:06 +0000
Subject: [PATCH 2/2] Improve compile:forms/2 documentation

---
 lib/compiler/doc/src/compile.xml | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml
index 3465141de0..89cd14a8dd 100644
--- a/lib/compiler/doc/src/compile.xml
+++ b/lib/compiler/doc/src/compile.xml
@@ -43,6 +43,10 @@
 <name>option() = term()</name>
 <desc>See <seemfa marker="#file/2">file/2</seemfa> for detailed description</desc>
 </datatype>
+ <datatype>
+ <name>forms() = term()</name>
+ <desc>List of Erlang abstract or Core Erlang format representations, as used by <seemfa marker="#forms/2">forms/2</seemfa></desc>
+ </datatype>
 </datatypes>
 
 <funcs>
@@ -774,15 +778,20 @@ module.beam: module.erl \
 <name since="">forms(Forms, Options) -> CompRet</name>
 <fsummary>Compiles a list of forms.</fsummary>
 <type>
- <v>Forms = [Form]</v>
+ <v>Forms = <seetype marker="#forms">forms()</seetype></v>
+ <v>forms() = [<seetype marker="erl_parse#abstract_form">erl_parse:abstract_form</seetype>] | <seeerl marker="cerl#type-c_module">cerl:c_module()</seeerl></v>
+ <v>Options = [<seetype marker="#option">option()</seetype>]</v>
 <v>CompRet = BinRet | ErrRet</v>
 <v>BinRet = {ok,ModuleName,BinaryOrCode} | {ok,ModuleName,BinaryOrCode,Warnings}</v>
+ <v>ModuleName = module()</v>
 <v>BinaryOrCode = binary() | term()</v>
 <v>ErrRet = error | {error,Errors,Warnings}</v>
+ <v>Warnings = Errors = [{<seetype marker="file#filename">file:filename()</seetype>, [{<seetype marker="erl_anno#line">erl_anno:line()</seetype> | 'none', module(), term()}]}]</v>
 </type>
 <desc>
 Analogous to <c>file/1</c>, but takes a list of forms (in
-	 the Erlang abstract format representation) as first argument.
+	 either Erlang abstract or Core Erlang format representation)
+ as first argument.
 Option <c>binary</c> is implicit, that is, no object code
 	 file is produced. For options that normally produce a listing 
 	 file, such as 'E', the internal format for that compiler pass 
-- 
2.26.2

Places

File 2442-Improve-compile-forms-2-documentation.patch of Package erlang

Places