← Back to branch summary

~clint-fewbar/ubuntu/precise/erlang/merge-15b

« back to all changes in this revision

Viewing changes to lib/edoc/doc/src/notes.xml

  • Committer: Package Import Robot
  • Author(s): Sergei Golovan
  • Date: 2011-12-15 19:20:10 UTC
  • mfrom: (1.1.18) (3.5.15 sid)
  • mto: (3.5.16 sid)
  • mto: This revision was merged to the branch mainline in revision 33.
  • Revision ID: package-import@ubuntu.com-20111215192010-jnxcfe3tbrpp0big
Tags: 1:15.b-dfsg-1
* New upstream release.
* Upload to experimental because this release breaks external drivers
  API along with ABI, so several applications are to be fixed.
* Removed SSL patch because the old SSL implementation is removed from
  the upstream distribution.
* Removed never used patch which added native code to erlang beam files.
* Removed the erlang-docbuilder binary package because the docbuilder
  application was dropped by upstream.
* Documented dropping ${erlang-docbuilder:Depends} substvar in
  erlang-depends(1) manpage.
* Made erlang-base and erlang-base-hipe provide virtual package
  erlang-abi-15.b (the number means the first erlang version, which
  provides current ABI).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/edoc/doc/src/notes.xml
4
4
<chapter>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>2007</year><year>2010</year>
 
7
      <year>2007</year><year>2011</year>
8
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
9
9
    </copyright>
10
10
    <legalnotice>
31
31
  <p>This document describes the changes made to the EDoc
32
32
    application.</p>
33
33
 
 
34
<section><title>Edoc 0.7.9.1</title>
 
35
 
 
36
    <section><title>Improvements and New Features</title>
 
37
      <list>
 
38
        <item>
 
39
          <p>
 
40
            Miscellaneous documentation build updates</p>
 
41
          <p>
 
42
            Own Id: OTP-9813</p>
 
43
        </item>
 
44
      </list>
 
45
    </section>
 
46
 
 
47
</section>
 
48
 
 
49
<section><title>Edoc 0.7.9</title>
 
50
 
 
51
    <section><title>Fixed Bugs and Malfunctions</title>
 
52
      <list>
 
53
        <item>
 
54
            <p><c>no_return</c> is a new built-in type. </p>
 
55
          <p>
 
56
            Own Id: OTP-9350</p>
 
57
        </item>
 
58
        <item>
 
59
          <p>
 
60
            synchronized with edoc development version</p>
 
61
          <p>
 
62
            forgot to ensure that xmerl is found in path for
 
63
            include_lib to work</p>
 
64
          <p>
 
65
            fix -spec declaration that doesn't work in R13B04</p>
 
66
          <p>
 
67
            eliminate warnings about unused imports</p>
 
68
          <p>
 
69
            removed CVS-keywords from source files (Thanks to Richard
 
70
            Carlsson )</p>
 
71
          <p>
 
72
            Own Id: OTP-9463</p>
 
73
        </item>
 
74
        <item>
 
75
          <p>
 
76
            Add a proplist() type</p>
 
77
          <p>
 
78
            Recently I was adding specs to an API and found that
 
79
            there is no canonical proplist() type defined. (Thanks to
 
80
            Ryan Zezeski)</p>
 
81
          <p>
 
82
            Own Id: OTP-9499</p>
 
83
        </item>
 
84
        <item>
 
85
          <p>
 
86
            Removed some never-matching clauses reported by dialyzer
 
87
            Fix macro expansion in comments following Erlang types
 
88
            URI-escape bytes as two hex digits always (reported by
 
89
            Alfonso De Gregorio) Updated author e-mail Recognize some
 
90
            more URI schemas in wiki text, in particular https
 
91
            (Thanks to Richard Carlsson)</p>
 
92
          <p>
 
93
            Own Id: OTP-9590</p>
 
94
        </item>
 
95
      </list>
 
96
    </section>
 
97
 
 
98
</section>
 
99
 
 
100
<section><title>Edoc 0.7.8</title>
 
101
 
 
102
    <section><title>Fixed Bugs and Malfunctions</title>
 
103
      <list>
 
104
        <item>
 
105
          <p>
 
106
            Fix infinite loop for malformed edoc input</p>
 
107
          <p>
 
108
            When processing an edoc comment with ``` in it, if the
 
109
            comment ends without a matching ''' then an infinite loop
 
110
            occurs in the function edoc_wiki:strip_empty_lines/2.
 
111
            This change fixes that by adding a clause to return from
 
112
            the function upon the end of the comment input. This
 
113
            allows an error to be thrown to indicate the problem,
 
114
            which is the same behaviour as leaving either `` or `
 
115
            unmatched. (Thanks to Taylor Venable)</p>
 
116
          <p>
 
117
            Own Id: OTP-9165</p>
 
118
        </item>
 
119
        <item>
 
120
            <p> Bugs concerning the option
 
121
            <c>report_missing_types</c> that was added in EDoc-0.7.7
 
122
            have been corrected: the option was misspelled in the
 
123
            source, and local definitions as well as the function
 
124
            tags <c>@private</c> and <c>@hidden</c> were not handled
 
125
            correctly. (Thanks to Manolis Papadakis.) </p>
 
126
          <p>
 
127
            Own Id: OTP-9301</p>
 
128
        </item>
 
129
      </list>
 
130
    </section>
 
131
 
 
132
</section>
 
133
 
 
134
<section><title>Edoc 0.7.7</title>
 
135
 
 
136
    <section><title>Fixed Bugs and Malfunctions</title>
 
137
      <list>
 
138
        <item>
 
139
            <p> Add encoding when parsing Wiki text. EDoc used to
 
140
            fail on strings such as "���". (Thanks to Richard
 
141
            Carlsson.) </p>
 
142
          <p>
 
143
            Own Id: OTP-9109</p>
 
144
        </item>
 
145
      </list>
 
146
    </section>
 
147
 
 
148
 
 
149
    <section><title>Improvements and New Features</title>
 
150
      <list>
 
151
        <item>
 
152
            <p> It is now possible to use Erlang specifications and
 
153
            types in EDoc documentation. Erlang specifications and
 
154
            types will be used unless there is also a function
 
155
            specification (<c>@spec</c>) or a type alias
 
156
            (<c>@type</c>) with the same name. In the current
 
157
            implementation the placement of <c>-spec</c> matters: it
 
158
            should be placed where the <c>@spec</c> would otherwise
 
159
            have been placed. </p>
 
160
            <p>Not all Erlang types are included in the
 
161
            documentation, but only those exported by some
 
162
            <c>export_type</c> declaration or used by some documented
 
163
            Erlang specification (<c>-spec</c>). </p>
 
164
            <p> There is currently no support for overloaded Erlang
 
165
            specifications. </p>
 
166
            <p> The syntax definitions of EDoc have been augmented to
 
167
            cope with most of the Erlang types. (But we recommend
 
168
            that Erlang types should be used instead.) </p>
 
169
            <p> <c>edoc:read_source()</c> takes one new option,
 
170
            <c>report_missing_types</c>. <c>edoc_layout:module()</c>
 
171
            takes one new option, <c>pretty_printer</c>. </p>
 
172
          <p>
 
173
            Own Id: OTP-8525</p>
 
174
        </item>
 
175
        <item>
 
176
            <p> The <c>edoc_lib</c> module is meant to be private,
 
177
            but since it is referred to from other man pages it has
 
178
            been included in the OTP documentation. The modifications
 
179
            introduced in this ticket make all functions private
 
180
            except those referred to from other pages. </p>
 
181
          <p>
 
182
            Own Id: OTP-9110</p>
 
183
        </item>
 
184
      </list>
 
185
    </section>
 
186
 
 
187
</section>
 
188
 
34
189
<section><title>Edoc 0.7.6.8</title>
35
190
 
36
191
    <section><title>Improvements and New Features</title>