Sophie

Sophie

distrib > Fedora > 17 > i386 > media > updates > by-pkgid > 675c8c8167236dfcf8d66da674f931e8 > files > 551

erlang-doc-R15B-03.3.fc17.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- EDoc Release Notes</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
            <!--
              function getWinHeight() {
                var myHeight = 0;
                if( typeof( window.innerHeight ) == 'number' ) {
                  //Non-IE
                  myHeight = window.innerHeight;
                } else if( document.documentElement && ( document.documentElement.clientWidth ||
                                                         document.documentElement.clientHeight ) ) {
                  //IE 6+ in 'standards compliant mode'
                  myHeight = document.documentElement.clientHeight;
                } else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
                  //IE 4 compatible
                  myHeight = document.body.clientHeight;
                }
                return myHeight;
              }

              function setscrollpos() {
                var objf=document.getElementById('loadscrollpos');
                 document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
              }

              function addEvent(obj, evType, fn){
                if (obj.addEventListener){
                obj.addEventListener(evType, fn, true);
                return true;
              } else if (obj.attachEvent){
                var r = obj.attachEvent("on"+evType, fn);
                return r;
              } else {
                return false;
              }
             }

             addEvent(window, 'load', setscrollpos);

             //--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/edoc-0.7.10.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>EDoc</strong><br><strong>Release Notes</strong><br><small>Version 0.7.10</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Chapters</strong></small></p>
<ul class="flipMenu" imagepath="../../../../doc/js/flipmenu"><li id="loadscrollpos" title="EDoc Release Notes" expanded="true">EDoc Release Notes<ul>
<li><a href="notes.html">
              Top of chapter
            </a></li>
<li title="Edoc 0.7.10"><a href="notes.html#id57911">Edoc 0.7.10</a></li>
<li title="Edoc 0.7.9.1"><a href="notes.html#id57943">Edoc 0.7.9.1</a></li>
<li title="Edoc 0.7.9"><a href="notes.html#id64916">Edoc 0.7.9</a></li>
<li title="Edoc 0.7.8"><a href="notes.html#id66250">Edoc 0.7.8</a></li>
<li title="Edoc 0.7.7"><a href="notes.html#id66311">Edoc 0.7.7</a></li>
<li title="Edoc 0.7.6.8"><a href="notes.html#id66511">Edoc 0.7.6.8</a></li>
<li title="Edoc 0.7.6.7"><a href="notes.html#id66540">Edoc 0.7.6.7</a></li>
<li title="Edoc 0.7.6.6"><a href="notes.html#id66574">Edoc 0.7.6.6</a></li>
<li title="Edoc 0.7.6.5"><a href="notes.html#id60164">Edoc 0.7.6.5</a></li>
<li title="Edoc 0.7.6.4"><a href="notes.html#id60195">Edoc 0.7.6.4</a></li>
<li title="Edoc 0.7.6.3"><a href="notes.html#id60225">Edoc 0.7.6.3</a></li>
<li title="Edoc 0.7.6.2"><a href="notes.html#id60254">Edoc 0.7.6.2</a></li>
<li title="Edoc 0.7.6.1"><a href="notes.html#id60284">Edoc 0.7.6.1</a></li>
<li title="Edoc 0.7.6"><a href="notes.html#id60317">Edoc 0.7.6</a></li>
<li title="Edoc 0.7.5"><a href="notes.html#id65800">Edoc 0.7.5</a></li>
<li title="Edoc 0.7.3"><a href="notes.html#id65831">Edoc 0.7.3</a></li>
<li title="EDoc 0.7.2"><a href="notes.html#id65875">EDoc 0.7.2</a></li>
<li title="EDoc 0.7.1"><a href="notes.html#id56736">EDoc 0.7.1</a></li>
<li title="EDoc 0.7.0"><a href="notes.html#id56768">EDoc 0.7.0</a></li>
</ul>
</li></ul>
</div></div>
<div id="content">
<div class="innertube">
<h1>1 EDoc Release Notes</h1>
  
  <p>This document describes the changes made to the EDoc
    application.</p>

<h3><a name="id57911">1.1 
        Edoc 0.7.10</a></h3>

    <h4>Fixed Bugs and Malfunctions</h4>
      <ul>
        <li>
          <p>
	    List behaviour callbacks in Edoc when using -callback
	    attribute. (Thanks to Magnus Henoch.)</p>
          <p>
	    Added special case for file names under Windows. (Thanks
	    to Beads Land-Trujillo.)</p>
          <p>
	    Own Id: OTP-10174</p>
        </li>
      </ul>
    



<h3><a name="id57943">1.2 
        Edoc 0.7.9.1</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
          <p>
	    Miscellaneous documentation build updates</p>
          <p>
	    Own Id: OTP-9813</p>
        </li>
      </ul>
    



<h3><a name="id64916">1.3 
        Edoc 0.7.9</a></h3>

    <h4>Fixed Bugs and Malfunctions</h4>
      <ul>
        <li>
	    <p><span class="code">no_return</span> is a new built-in type. </p>
          <p>
	    Own Id: OTP-9350</p>
        </li>
        <li>
          <p>
	    synchronized with edoc development version</p>
          <p>
	    forgot to ensure that xmerl is found in path for
	    include_lib to work</p>
          <p>
	    fix -spec declaration that doesn't work in R13B04</p>
          <p>
	    eliminate warnings about unused imports</p>
          <p>
	    removed CVS-keywords from source files (Thanks to Richard
	    Carlsson )</p>
          <p>
	    Own Id: OTP-9463</p>
        </li>
        <li>
          <p>
	    Add a proplist() type</p>
          <p>
	    Recently I was adding specs to an API and found that
	    there is no canonical proplist() type defined. (Thanks to
	    Ryan Zezeski)</p>
          <p>
	    Own Id: OTP-9499</p>
        </li>
        <li>
          <p>
	    Removed some never-matching clauses reported by dialyzer
	    Fix macro expansion in comments following Erlang types
	    URI-escape bytes as two hex digits always (reported by
	    Alfonso De Gregorio) Updated author e-mail Recognize some
	    more URI schemas in wiki text, in particular https
	    (Thanks to Richard Carlsson)</p>
          <p>
	    Own Id: OTP-9590</p>
        </li>
      </ul>
    



<h3><a name="id66250">1.4 
        Edoc 0.7.8</a></h3>

    <h4>Fixed Bugs and Malfunctions</h4>
      <ul>
        <li>
          <p>
	    Fix infinite loop for malformed edoc input</p>
          <p>
	    When processing an edoc comment with ``` in it, if the
	    comment ends without a matching ''' then an infinite loop
	    occurs in the function edoc_wiki:strip_empty_lines/2.
	    This change fixes that by adding a clause to return from
	    the function upon the end of the comment input. This
	    allows an error to be thrown to indicate the problem,
	    which is the same behaviour as leaving either `` or `
	    unmatched. (Thanks to Taylor Venable)</p>
          <p>
	    Own Id: OTP-9165</p>
        </li>
        <li>
	    <p> Bugs concerning the option
	    <span class="code">report_missing_types</span> that was added in EDoc-0.7.7
	    have been corrected: the option was misspelled in the
	    source, and local definitions as well as the function
	    tags <span class="code">@private</span> and <span class="code">@hidden</span> were not handled
	    correctly. (Thanks to Manolis Papadakis.) </p>
          <p>
	    Own Id: OTP-9301</p>
        </li>
      </ul>
    



<h3><a name="id66311">1.5 
        Edoc 0.7.7</a></h3>

    <h4>Fixed Bugs and Malfunctions</h4>
      <ul>
        <li>
	    <p> Add encoding when parsing Wiki text. EDoc used to
	    fail on strings such as "äåö". (Thanks to Richard
	    Carlsson.) </p>
          <p>
	    Own Id: OTP-9109</p>
        </li>
      </ul>
    


    <h4>Improvements and New Features</h4>
      <ul>
        <li>
	    <p> It is now possible to use Erlang specifications and
	    types in EDoc documentation. Erlang specifications and
	    types will be used unless there is also a function
	    specification (<span class="code">@spec</span>) or a type alias
	    (<span class="code">@type</span>) with the same name. In the current
	    implementation the placement of <span class="code">-spec</span> matters: it
	    should be placed where the <span class="code">@spec</span> would otherwise
	    have been placed. </p>
	    <p>Not all Erlang types are included in the
	    documentation, but only those exported by some
	    <span class="code">export_type</span> declaration or used by some documented
	    Erlang specification (<span class="code">-spec</span>). </p>
	    <p> There is currently no support for overloaded Erlang
	    specifications. </p>
	    <p> The syntax definitions of EDoc have been augmented to
	    cope with most of the Erlang types. (But we recommend
	    that Erlang types should be used instead.) </p>
	    <p> <span class="code">edoc:read_source()</span> takes one new option,
	    <span class="code">report_missing_types</span>. <span class="code">edoc_layout:module()</span>
	    takes one new option, <span class="code">pretty_printer</span>. </p>
          <p>
	    Own Id: OTP-8525</p>
        </li>
        <li>
	    <p> The <span class="code">edoc_lib</span> module is meant to be private,
	    but since it is referred to from other man pages it has
	    been included in the OTP documentation. The modifications
	    introduced in this ticket make all functions private
	    except those referred to from other pages. </p>
          <p>
	    Own Id: OTP-9110</p>
        </li>
      </ul>
    



<h3><a name="id66511">1.6 
        Edoc 0.7.6.8</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
          <p>
	    Compiler warnings were eliminated.</p>
          <p>
	    Own Id: OTP-8855</p>
        </li>
      </ul>
    



<h3><a name="id66540">1.7 
        Edoc 0.7.6.7</a></h3>

    <h4>Fixed Bugs and Malfunctions</h4>
      <ul>
        <li>
	    <p>Edoc now uses the new API functions to <span class="code">inets</span>
	    instead of the deprecated ones.</p>
          <p>
	    Own Id: OTP-8749</p>
        </li>
      </ul>
    



<h3><a name="id66574">1.8 
        Edoc 0.7.6.6</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
	    <p>The documentation is now possible to build in an open
	    source environment after a number of bugs are fixed and
	    some features are added in the documentation build
	    process. </p>
	    <p>- The arity calculation is updated.</p>
	    <p>- The module prefix used in the function names for
	    bif's are removed in the generated links so the links
	    will look like
	    "http://www.erlang.org/doc/man/erlang.html#append_element-2"
	    instead of
	    "http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2".</p>
	    <p>- Enhanced the menu positioning in the html
	    documentation when a new page is loaded.</p>
	    <p>- A number of corrections in the generation of man
	    pages (thanks to Sergei Golovan)</p>
	    <p>- The legal notice is taken from the xml book file so
	    OTP's build process can be used for non OTP
	    applications.</p>
          <p>
	    Own Id: OTP-8343</p>
        </li>
      </ul>
    



<h3><a name="id60164">1.9 
        Edoc 0.7.6.5</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
          <p>
	    The documentation is now built with open source tools
	    (xsltproc and fop) that exists on most platforms. One
	    visible change is that the frames are removed.</p>
          <p>
	    Own Id: OTP-8201</p>
        </li>
      </ul>
    



<h3><a name="id60195">1.10 
        Edoc 0.7.6.4</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
          <p>
	    Miscellaneous updates.</p>
          <p>
	    Own Id: OTP-8190</p>
        </li>
      </ul>
    



<h3><a name="id60225">1.11 
        Edoc 0.7.6.3</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
	    <p>The copyright notices have been updated.</p>
          <p>
	    Own Id: OTP-7851</p>
        </li>
      </ul>
    



<h3><a name="id60254">1.12 
        Edoc 0.7.6.2</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
          <p>
	    Minor updates.</p>
          <p>
	    Own Id: OTP-7642</p>
        </li>
      </ul>
    



<h3><a name="id60284">1.13 
        Edoc 0.7.6.1</a></h3>

    <h4>Fixed Bugs and Malfunctions</h4>
      <ul>
        <li>
          <p>
	    Correction to work with new versions of STDLIB that no
	    longer has the <span class="code">erl_internal:obsolete/3</span> function.</p>
          <p>
	    Own Id: OTP-7539</p>
        </li>
      </ul>
    



<h3><a name="id60317">1.14 
        Edoc 0.7.6</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
          <p>
	    Minor changes.</p>
          <p>
	    Own Id: OTP-7388</p>
        </li>
      </ul>
    



<h3><a name="id65800">1.15 
        Edoc 0.7.5</a></h3>

    <h4>Improvements and New Features</h4>
      <ul>
        <li>
          <p>
	    Minor updates, mostly cosmetic.</p>
          <p>
	    Own Id: OTP-7243</p>
        </li>
      </ul>
    



  <h3><a name="id65831">1.16 
        Edoc 0.7.3</a></h3>
    

    <h4>Improvements and New Features</h4>
      
      <ul>
        <li>
          <p>Minor Makefile changes.</p>
          <p>Own Id: OTP-6689</p>
        </li>
        <li>
          <p>Dialyzer warnings were eliminated.</p>
          <p>Own Id: OTP-6737</p>
        </li>
      </ul>
    
  

  <h3><a name="id65875">1.17 
        EDoc 0.7.2</a></h3>
    

    <h4>Fixed Bugs and Malfunctions</h4>
      
      <ul>
        <li>
          <p>Some missing files have been added:
            <span class="code">~/include/edoc_doclet.hrl</span>, <span class="code">~/priv/edoc.dtd</span>,
            <span class="code">~/priv/erlang.png</span></p>
          <p>Own Id: OTP-6457</p>
        </li>
      </ul>
    

    <h4>Improvements and New Features</h4>
      
      <ul>
        <li>
          <ul>
            <li>Undefined macros only cause warnings, not errors.</li>
            <li>New, built-in <span class="code">@version</span> macro.</li>
            <li>Documented the <span class="code">@docfile</span> and <span class="code">@headerfile</span>
             generic tags.</li>
            <li>Added recognition of <span class="code">"TODO:"</span> as a wiki
             equivalent for <span class="code">@todo</span> tags.</li>
            <li>Added documentation about overview pages.</li>
            <li>
<span class="code">'where'</span> and <span class="code">','</span> are allowed as
             separators in specs.</li>
            <li>Corrected ambiguity in spec grammar (possible
             incompatibility issue - parentheses may need to be added
             in some cases, in existing code).</li>
            <li>Experimental (and undocumented) support for
            <span class="code">@param</span> and <span class="code">@return</span> tags and corresponding
            <span class="code">"..."</span> annotations on <span class="code">@spec</span> parameters.</li>
          </ul>
          <p>*** POTENTIAL INCOMPATIBILITY ***</p>
          <p>Own Id: OTP-6568</p>
        </li>
      </ul>
    
  

  <h3><a name="id56736">1.18 
        EDoc 0.7.1</a></h3>
    

    <h4>Fixed Bugs and Malfunctions</h4>
      
      <ul>
        <li>
          <p>Fixed some broken links in the documentation.</p>
          <p>Own Id: OTP-6419</p>
        </li>
      </ul>
    
  

  <h3><a name="id56768">1.19 
        EDoc 0.7.0</a></h3>
    
    <p>Miscellaneous changes.</p>
  
</div>
<div class="footer">
<hr>
<p>Copyright © 2006-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>