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

Overview Repositories Revisions Requests Users Attributes Meta

File 3112-Improve-compile-forms-2-documentation.patch of Package erlang (Revision 66a224e208ffe9ee89602bad56a74dfa)

Currently displaying revision 66a224e208ffe9ee89602bad56a74dfa , Show latest

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
@@ -755,15 +755,20 @@ module.beam: module.erl \
       <name>forms(Forms, Options) -> CompRet</name>
       <fsummary>Compiles a list of forms.</fsummary>
       <type>
-        <v>Forms = [Form]</v>
+        <v>Forms = <seealso marker="#type-forms">forms()</seealso></v>
+        <v>forms() = [<seealso marker="erl_parse#type-abstract_form">erl_parse:abstract_form</seealso>] | <seealso marker="cerl#type-c_module">cerl:c_module()</seealso></v>
+        <v>Options = [<seealso marker="#type-option">option()</seealso>]</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 = [{<seealso marker="file#type-filename">file:filename()</seealso>, [{<seealso marker="erl_anno#type-line">erl_anno:line()</seealso> | 'none', module(), term()}]}]</v>
       </type>
       <desc>
         <p>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 3112-Improve-compile-forms-2-documentation.patch of Package erlang (Revision 66a224e208ffe9ee89602bad56a74dfa)

Places