aboutsummaryrefslogblamecommitdiffstats
path: root/lib/edoc/doc/src/notes.xml
blob: afcccf22b5e048f870a75bd50f5244706b90eb5f (plain) (tree)
1
2
3
4
5
6
7





                                        
                                        







                                                                         
 



                                                                            
 











                                                         














                                                         














                                                                  






























                                                                                    



























































































































































































                                                                                               
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">

<chapter>
  <header>
    <copyright>
      <year>2007</year><year>2010</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      The contents of this file are subject to the Erlang Public License,
      Version 1.1, (the "License"); you may not use this file except in
      compliance with the License. You should have received a copy of the
      Erlang Public License along with this software. If not, it can be
      retrieved online at http://www.erlang.org/.

      Software distributed under the License is distributed on an "AS IS"
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      the License for the specific language governing rights and limitations
      under the License.

    </legalnotice>

    <title>EDoc Release Notes</title>
    <prepared>otp_appnotes</prepared>
    <docno>nil</docno>
    <date>nil</date>
    <rev>nil</rev>
    <file>notes.xml</file>
  </header>
  <p>This document describes the changes made to the EDoc
    application.</p>

<section><title>Edoc 0.7.6.8</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Compiler warnings were eliminated.</p>
          <p>
	    Own Id: OTP-8855</p>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6.7</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
	    <p>Edoc now uses the new API functions to <c>inets</c>
	    instead of the deprecated ones.</p>
          <p>
	    Own Id: OTP-8749</p>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6.6</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <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>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6.5</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <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>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6.4</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Miscellaneous updates.</p>
          <p>
	    Own Id: OTP-8190</p>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6.3</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>The copyright notices have been updated.</p>
          <p>
	    Own Id: OTP-7851</p>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Minor updates.</p>
          <p>
	    Own Id: OTP-7642</p>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Correction to work with new versions of STDLIB that no
	    longer has the <c>erl_internal:obsolete/3</c> function.</p>
          <p>
	    Own Id: OTP-7539</p>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.6</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Minor changes.</p>
          <p>
	    Own Id: OTP-7388</p>
        </item>
      </list>
    </section>

</section>

<section><title>Edoc 0.7.5</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Minor updates, mostly cosmetic.</p>
          <p>
	    Own Id: OTP-7243</p>
        </item>
      </list>
    </section>

</section>

  <section>
    <title>Edoc 0.7.3</title>

    <section>
      <title>Improvements and New Features</title>
      <list type="bulleted">
        <item>
          <p>Minor Makefile changes.</p>
          <p>Own Id: OTP-6689</p>
        </item>
        <item>
          <p>Dialyzer warnings were eliminated.</p>
          <p>Own Id: OTP-6737</p>
        </item>
      </list>
    </section>
  </section>

  <section>
    <title>EDoc 0.7.2</title>

    <section>
      <title>Fixed Bugs and Malfunctions</title>
      <list type="bulleted">
        <item>
          <p>Some missing files have been added:
            <c><![CDATA[~/include/edoc_doclet.hrl]]></c>, <c><![CDATA[~/priv/edoc.dtd]]></c>,
            <c><![CDATA[~/priv/erlang.png]]></c></p>
          <p>Own Id: OTP-6457</p>
        </item>
      </list>
    </section>

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

  <section>
    <title>EDoc 0.7.1</title>

    <section>
      <title>Fixed Bugs and Malfunctions</title>
      <list type="bulleted">
        <item>
          <p>Fixed some broken links in the documentation.</p>
          <p>Own Id: OTP-6419</p>
        </item>
      </list>
    </section>
  </section>

  <section>
    <title>EDoc 0.7.0</title>
    <p>Miscellaneous changes.</p>
  </section>
</chapter>