From 68d53c01b0b8e9a007a6a30158c19e34b2d2a34e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Wed, 18 May 2016 15:53:35 +0200 Subject: Update STDLIB documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Language cleaned up by the technical writers xsipewe and tmanevik from Combitech. Proofreading and corrections by Björn Gustavsson and Hans Bolinder. --- lib/stdlib/doc/src/epp.xml | 231 +++++++++++++++++++++++++-------------------- 1 file changed, 129 insertions(+), 102 deletions(-) (limited to 'lib/stdlib/doc/src/epp.xml') diff --git a/lib/stdlib/doc/src/epp.xml b/lib/stdlib/doc/src/epp.xml index ac87f9c2b6..1dc0161398 100644 --- a/lib/stdlib/doc/src/epp.xml +++ b/lib/stdlib/doc/src/epp.xml @@ -28,214 +28,241 @@ 1 Kenneth Lundin - 97-01-31 + 1997-01-31 B - epp.sgml + epp.xml epp - An Erlang Code Preprocessor + An Erlang code preprocessor. -

The Erlang code preprocessor includes functions which are used - by compile to preprocess macros and include files before - the actual parsing takes place.

+

The Erlang code preprocessor includes functions that are used by the + compile + module to preprocess macros and include files before + the parsing takes place.

+

The Erlang source file encoding is selected by a comment in one of the first two lines of the source file. The - first string that matches the regular expression + first string matching the regular expression coding\s*[:=]\s*([-a-zA-Z0-9])+ selects the encoding. If - the matching string is not a valid encoding it is ignored. The - valid encodings are Latin-1 and UTF-8 where the - case of the characters can be chosen freely. Examples:

- 
+      the matching string is not a valid encoding, it is ignored. The
+      valid encodings are Latin-1 and UTF-8, where the
+      case of the characters can be chosen freely.

+
+    
Examples:

+
+    
 %% coding: utf-8

-      
+
+    
 %% For this file we have chosen encoding = Latin-1

-      
+
+    
 %% -*- coding: latin-1 -*-

   
+
   
     
       
     
     
       
-      
Handle to the epp server.

+      
Handle to the epp server.

     
     
       
     
   
+
   
     
-      
-      Open a file for preprocessing
+      
+      Close the preprocessing of the file associated with Epp.
+      
       
-        
Opens a file for preprocessing.

-	
If extra is given in
-	Options, the return value will be
-	{ok, Epp, Extra} instead
-	of {ok, Epp}.

+        
Closes the preprocessing of a file.

       
     
+
     
-      
-      Open a file for preprocessing
+      
+      Return the default encoding of Erlang source files.
       
-        
Equivalent to epp:open([{name, FileName}, {includes, IncludePath}]).

+        
Returns the default encoding of Erlang source files.

       
     
+
     
-      
-      Open a file for preprocessing
+      
+      Return a string representation of an encoding.
       
-        
Equivalent to epp:open([{name, FileName}, {includes, IncludePath},
-	{macros, PredefMacros}]).

+        
Returns a string representation of an encoding. The string
+          is recognized by
+          read_encoding/1,2,
+          
+          read_encoding_from_binary/1,2, and
+          set_encoding/1,2
+          as a valid encoding.

       
     
+
     
-      
-      Close the preprocessing of the file associated with Epp
+      
+      Format an error descriptor.
       
-        
Closes the preprocessing of a file.

+        
Takes an ErrorDescriptor and returns
+          a string that
+          describes the error or warning. This function is usually
+          called implicitly when processing an ErrorInfo
+          structure (see section
+          Error Information).

       
     
+
     
-      
-      Return the next Erlang form from the opened Erlang source file
-      
+      
+      Open a file for preprocessing.
       
-        
Returns the next Erlang form from the opened Erlang source file.
-          The tuple {eof, Line} is returned at end-of-file. The first
-          form corresponds to an implicit attribute -file(File,1)., where
-          File is the name of the file.

+        
Opens a file for preprocessing.

+        
If extra is specified in
+          Options, the return value is
+          {ok, Epp, Extra} instead
+          of {ok, Epp}.

       
     
+
     
-      
-      Preprocess and parse an Erlang source file
+      
+      Open a file for preprocessing.
       
-        
Preprocesses and parses an Erlang source file.
-	Note that the tuple {eof, Line} returned
-	at end-of-file is included as a "form".

-	
If extra is given in
-	Options, the return value will be
-	{ok, [Form], Extra} instead
-	of {ok, [Form]}.

+        
Equivalent to
+          epp:open([{name, FileName}, {includes, IncludePath}]).

       
     
+
     
-      
-      Preprocess and parse an Erlang source file
+      
+      Open a file for preprocessing.
       
-        
Equivalent to epp:parse_file(FileName, [{includes, IncludePath},
-	{macros, PredefMacros}]).

+        
Equivalent to epp:open([{name, FileName}, {includes, IncludePath},
+          {macros, PredefMacros}]).

       
     
+
     
-      
-      Return the default encoding of Erlang source files
+      
+      Return the next Erlang form from the opened Erlang source file.
+      
+      
       
-        
Returns the default encoding of Erlang source files.

+        
Returns the next Erlang form from the opened Erlang source file.
+          Tuple {eof, Line} is returned at the end of the
+          file. The first form corresponds to an implicit attribute
+          -file(File,1)., where File is the file name.

       
     
+
     
-      
-      Return a string representation of an encoding
+      
+      Preprocess and parse an Erlang source file.
       
-        
Returns a string representation of an encoding. The string
-        is recognized by read_encoding/1,2,
-        read_encoding_from_binary/1,2, and
-        set_encoding/1,2 as a valid encoding.

+        
Preprocesses and parses an Erlang source file.
+          Notice that tuple {eof, Line} returned at the
+          end of the file is included as a "form".

+        
If extra is specified in
+         Options, the return value is
+         {ok, [Form], Extra} instead
+         of {ok, [Form]}.

+      
+    
+
+    
+      
+      Preprocess and parse an Erlang source file.
+      
+        
Equivalent to epp:parse_file(FileName, [{includes, IncludePath},
+          {macros, PredefMacros}]).

       
     
+
     
       
       
-      Read the encoding from a file
+      Read the encoding from a file.
       
         
Read the encoding from
           a file. Returns the read encoding, or none if no
-          valid encoding was found.

-        
The option in_comment_only is true by
+          valid encoding is found.

+        
Option in_comment_only is true by
           default, which is correct for Erlang source files. If set to
-          false the encoding string does not necessarily have to
+          false, the encoding string does not necessarily have to
           occur in a comment.

       
     
+
     
       
       
-      Read the encoding from a binary
+      Read the encoding from a binary.
       
         
Read the encoding from
           a binary. Returns the read encoding, or none if no
-          valid encoding was found.

-        
The option in_comment_only is true by
+          valid encoding is found.

+        
Option in_comment_only is true by
           default, which is correct for Erlang source files. If set to
-          false the encoding string does not necessarily have to
+          false, the encoding string does not necessarily have to
           occur in a comment.

       
     
+
     
       
-      Read and set the encoding of an IO device
+      Read and set the encoding of an I/O device.
       
         
Reads the encoding from
-          an IO device and sets the encoding of the device
-          accordingly. The position of the IO device referenced by
+          an I/O device and sets the encoding of the device
+          accordingly. The position of the I/O device referenced by
           File is not affected. If no valid
-          encoding can be read from the IO device the encoding of the
-          IO device is set to the default encoding.

+          encoding can be read from the I/O device, the encoding of the
+          I/O device is set to the default encoding.

         
Returns the read encoding, or none if no valid
-          encoding was found.

+          encoding is found.

       
     
+
     
       
-      Read and set the encoding of an IO device
+      Read and set the encoding of an I/O device.
       
         
Reads the encoding from
-          an IO device and sets the encoding of the device
-          accordingly. The position of the IO device referenced by
+          an I/O device and sets the encoding of the device
+          accordingly. The position of the I/O device referenced by
           File is not affected. If no valid
-          encoding can be read from the IO device the encoding of the
-          IO device is set to the
-	  encoding given by
-	  Default.

+          encoding can be read from the I/O device, the encoding of the
+          I/O device is set to the
+          encoding specified by
+          Default.

         
Returns the read encoding, or none if no valid
-          encoding was found.

-      
-    
-    
-      
-      Format an error descriptor
-      
-        
Takes an ErrorDescriptor and returns
-          a string which
-          describes the error or warning. This function is usually
-          called implicitly when processing an ErrorInfo
-          structure (see below).

+          encoding is found.

       
     
   
 
   

     Error Information
-    
The ErrorInfo mentioned above is the standard
-      ErrorInfo structure which is returned from all IO
-      modules. It has the following format:
-      

+    
+    
ErrorInfo is the standard ErrorInfo structure that is
+      returned from all I/O modules. The format is as follows:

     
-    {ErrorLine, Module, ErrorDescriptor}    
-    
A string which describes the error is obtained with the following call:
-      

+{ErrorLine, Module, ErrorDescriptor}
+    
A string describing the error is obtained with the following call:

     
-    Module:format_error(ErrorDescriptor)    
+Module:format_error(ErrorDescriptor)
   

 
   

     See Also
-    
erl_parse(3)

+    
erl_parse(3)

   

 
 
-- 
cgit v1.2.3