From afb632d2028fdc4a37e10e41e1929264ff59f52e Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 14 Mar 2013 09:53:33 +0100 Subject: Convert XML files to UTF-8, where needed --- lib/edoc/doc/src/notes.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 12f93ab400..37c917b65a 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -1,4 +1,4 @@ - + @@ -219,7 +219,7 @@

Add encoding when parsing Wiki text. EDoc used to - fail on strings such as "äåö". (Thanks to Richard + fail on strings such as "äåö". (Thanks to Richard Carlsson.)

Own Id: OTP-9109

-- cgit v1.2.3 From e5875001247e6a6ac4f474157a51a8c54f94ae49 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 14 Mar 2013 16:01:25 +0100 Subject: Convert XML files to UTF-8 --- lib/edoc/doc/src/book.xml | 4 ++-- lib/edoc/doc/src/fascicules.xml | 2 +- lib/edoc/doc/src/notes.xml | 2 +- lib/edoc/doc/src/part.xml | 4 ++-- lib/edoc/doc/src/part_notes.xml | 4 ++-- lib/edoc/doc/src/ref_man.xml | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/book.xml b/lib/edoc/doc/src/book.xml index 67b7cdb2d7..1a11629e6d 100644 --- a/lib/edoc/doc/src/book.xml +++ b/lib/edoc/doc/src/book.xml @@ -1,10 +1,10 @@ - +
- 20062009 + 20062013 Ericsson AB. All Rights Reserved. diff --git a/lib/edoc/doc/src/fascicules.xml b/lib/edoc/doc/src/fascicules.xml index 1b9d6bc94d..154c8a3b6d 100644 --- a/lib/edoc/doc/src/fascicules.xml +++ b/lib/edoc/doc/src/fascicules.xml @@ -1,4 +1,4 @@ - + diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 37c917b65a..d2ec82efc8 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -1,4 +1,4 @@ - + diff --git a/lib/edoc/doc/src/part.xml b/lib/edoc/doc/src/part.xml index a71b4eda13..876ae858f9 100644 --- a/lib/edoc/doc/src/part.xml +++ b/lib/edoc/doc/src/part.xml @@ -1,10 +1,10 @@ - +
- 20062009 + 20062013 Ericsson AB. All Rights Reserved. diff --git a/lib/edoc/doc/src/part_notes.xml b/lib/edoc/doc/src/part_notes.xml index 42fc39af42..41e6c1c7f7 100644 --- a/lib/edoc/doc/src/part_notes.xml +++ b/lib/edoc/doc/src/part_notes.xml @@ -1,10 +1,10 @@ - +
- 20072009 + 20072013 Ericsson AB. All Rights Reserved. diff --git a/lib/edoc/doc/src/ref_man.xml b/lib/edoc/doc/src/ref_man.xml index a9af8740b9..a71b35d118 100644 --- a/lib/edoc/doc/src/ref_man.xml +++ b/lib/edoc/doc/src/ref_man.xml @@ -1,10 +1,10 @@ - +
- 20062011 + 20062013 Ericsson AB. All Rights Reserved. -- cgit v1.2.3 From c011973178d860f280c6ce18b07ce4176aec5b35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Fri, 6 Sep 2013 13:40:21 +0200 Subject: Change encoding of troublesome notes.xml files to utf-8 Most notes.xml files will be updated in every release and cause the kind of the problems described in the previous commit. --- lib/edoc/doc/src/notes.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 12f93ab400..d2ec82efc8 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -1,4 +1,4 @@ - + @@ -219,7 +219,7 @@

Add encoding when parsing Wiki text. EDoc used to - fail on strings such as "äåö". (Thanks to Richard + fail on strings such as "äåö". (Thanks to Richard Carlsson.)

Own Id: OTP-9109

-- cgit v1.2.3 From 20641fe0f2ea745873fc7557448d3a7deb1bd639 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 16 Sep 2013 20:11:53 +0200 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index d2ec82efc8..394e7af09c 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -31,6 +31,23 @@

This document describes the changes made to the EDoc application.

+
Edoc 0.7.12.1 + +
Improvements and New Features + + +

+ The encoding of the notes.xml file has been + changed from latin1 to utf-8 to avoid future merge + problems.

+

+ Own Id: OTP-11310

+ + +
+ +
+
Edoc 0.7.12
Fixed Bugs and Malfunctions -- cgit v1.2.3 From f719d0fe308f00b85f92c29d7cdf9b0dc20d98a2 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 7 Apr 2014 19:52:48 +0200 Subject: Update release notes --- lib/edoc/doc/src/notes.xml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 394e7af09c..d7cbfa1fdc 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -31,6 +31,35 @@

This document describes the changes made to the EDoc application.

+
Edoc 0.7.13 + +
Fixed Bugs and Malfunctions + + +

+ Application upgrade (appup) files are corrected for the + following applications:

+

+ asn1, common_test, compiler, crypto, debugger, + dialyzer, edoc, eldap, erl_docgen, et, eunit, gs, hipe, + inets, observer, odbc, os_mon, otp_mibs, parsetools, + percept, public_key, reltool, runtime_tools, ssh, + syntax_tools, test_server, tools, typer, webtool, wx, + xmerl

+

+ A new test utility for testing appup files is added to + test_server. This is now used by most applications in + OTP.

+

+ (Thanks to Tobias Schlager)

+

+ Own Id: OTP-11744

+ + +
+ +
+
Edoc 0.7.12.1
Improvements and New Features -- cgit v1.2.3 From dba1d881f3232a939c6620f5fd6b4a97ff454bee Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Tue, 1 Jul 2014 13:58:47 +0200 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index d7cbfa1fdc..b3440ce6e1 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -31,6 +31,25 @@

This document describes the changes made to the EDoc application.

+
Edoc 0.7.14 + +
Fixed Bugs and Malfunctions + + +

The default encoding for Erlang source files is now + UTF-8. As a temporary measure to ease the transition from + the old default of Latin-1, if EDoc encounters byte + sequences that are not valid UTF-8 sequences, EDoc will + re-try in Latin-1 mode. This workaround will be removed + in a future release.

+

+ Own Id: OTP-12008

+ + +
+ +
+
Edoc 0.7.13
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 950d808c97a4c5b579f4f1cc16b95f2d419d3505 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 15 Sep 2014 12:02:14 +0200 Subject: Update release notes --- lib/edoc/doc/src/notes.xml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index b3440ce6e1..52b7529f70 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -31,6 +31,22 @@

This document describes the changes made to the EDoc application.

+
Edoc 0.7.15 + +
Fixed Bugs and Malfunctions + + +

+ Fix spec to doc generation from erl_docgen and edoc for + maps

+

+ Own Id: OTP-12058

+ + +
+ +
+
Edoc 0.7.14
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 7f3486a5ddc02a366f2945dfd009c4a2697a2b98 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Tue, 9 Dec 2014 15:21:47 +0100 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 52b7529f70..e350adb540 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -31,6 +31,22 @@

This document describes the changes made to the EDoc application.

+
Edoc 0.7.16 + +
Fixed Bugs and Malfunctions + + +

+ Maps: Properly align union typed assoc values in + documentation

+

+ Own Id: OTP-12190

+ + +
+ +
+
Edoc 0.7.15
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 6f492b98505ee6d68b9f438915dfbd3616a1b729 Mon Sep 17 00:00:00 2001 From: Vlad Dumitrescu Date: Fri, 16 Jan 2015 09:39:31 +0100 Subject: [edoc] remove functionality related to packages The 'subpackages' option is left, since some projects use recursive source directories. --- lib/edoc/doc/overview.edoc | 23 +++-------------------- 1 file changed, 3 insertions(+), 20 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/overview.edoc b/lib/edoc/doc/overview.edoc index 2af425272e..0ced8cab32 100644 --- a/lib/edoc/doc/overview.edoc +++ b/lib/edoc/doc/overview.edoc @@ -76,8 +76,6 @@ The following are the main functions for running EDoc:
  • {@link edoc:application/2}: Creates documentation for a typical Erlang application.
    • -
  • {@link edoc:packages/2}: Creates documentation for one or - more packages, automatically locating source files.
  • {@link edoc:files/2}: Creates documentation for a specified set of source files.
  • {@link edoc:run/3}: General interface function; the common @@ -184,7 +182,7 @@ The following tags can be used anywhere within a module: path (see {@link edoc:read_source/2}).
    `@todo' (or `@TODO')
    -
    Attaches a To-Do note to a function, module, package, or +
    Attaches a To-Do note to a function, module or overview-page. The content can be any XHTML text describing the issue, e.g.: ```%% @TODO Finish writing the documentation.''' @@ -338,7 +336,7 @@ The following tags can be used before a module declaration:
    `@since'
    Specifies when the module was introduced, with respect to - the application, package, release or distribution it is part + the application, release or distribution it is part of. The content can be arbitrary text.
    `@version'
    @@ -445,7 +443,6 @@ possible formats for references are: - @@ -531,7 +528,7 @@ after the empty line into separate paragraphs. For example: ```%% @doc This will all be part of the first paragraph. %% It can stretch over several lines and contain any %% XHTML markup. - %% + %% %% This is the second paragraph. The above line is %% regarded as "empty" by EDoc, even though it ends with %% a space.''' @@ -685,17 +682,6 @@ information. User-defined macros override predefined macros.
    Expands to the current date, as "Month Day Year", e.g. "{@date}".
    -
    @{@docRoot}
    -
    Expands to the relative URL path (such as - `"../../.."') from the current page to the root - directory of the generated documentation. This can be used to - create XHTML references such as `' that are independent of how - deep down in a package structure they occur. If packages are not - used (i.e., if all modules are in the "empty" package), - @{@docRoot} will always resolve to the empty - string.
    -
    @{@link reference. description}
    This creates a hypertext link; cf. the @@ -710,9 +696,6 @@ information. User-defined macros override predefined macros.
    Expands to the name of the current module. Only defined when a module is being processed.
    -
    @{@package}
    -
    Expands to the name of the current package.
    -
    @{@section heading}
    Expands to a hypertext link to the specified section heading; -- cgit v1.2.3 From 49b2127e3ea68464f7c02ad7f7875e304ded123e Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 10 Mar 2015 09:54:02 +0100 Subject: edoc: Correct documentation Substitute references to edoc_lib:get_doc_env/3 for references to edoc_lib:get_doc_env/4. --- lib/edoc/doc/overview.edoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/overview.edoc b/lib/edoc/doc/overview.edoc index 0ced8cab32..3639bb43a5 100644 --- a/lib/edoc/doc/overview.edoc +++ b/lib/edoc/doc/overview.edoc @@ -78,7 +78,7 @@ The following are the main functions for running EDoc: typical Erlang application.
  • {@link edoc:files/2}: Creates documentation for a specified set of source files.
    • -
  • {@link edoc:run/3}: General interface function; the common +
  • {@link edoc:run/2}: General interface function; the common back-end for the above functions. Options are documented here.
    • -- cgit v1.2.3 From 738c34d4bb8f1a3811acd00af8c6c12107f8315b Mon Sep 17 00:00:00 2001 From: Bruce Yinhe Date: Thu, 18 Jun 2015 11:31:02 +0200 Subject: Change license text to APLv2 --- lib/edoc/doc/Makefile | 21 +++++++++++---------- lib/edoc/doc/src/Makefile | 21 +++++++++++---------- lib/edoc/doc/src/book.xml | 21 +++++++++++---------- lib/edoc/doc/src/notes.xml | 21 +++++++++++---------- lib/edoc/doc/src/part.xml | 21 +++++++++++---------- lib/edoc/doc/src/part_notes.xml | 21 +++++++++++---------- lib/edoc/doc/src/ref_man.xml | 21 +++++++++++---------- 7 files changed, 77 insertions(+), 70 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/Makefile b/lib/edoc/doc/Makefile index 7a59809d9b..c635f07d78 100644 --- a/lib/edoc/doc/Makefile +++ b/lib/edoc/doc/Makefile @@ -1,13 +1,14 @@ -# ``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 via the world wide web 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. +# ``Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. # # The Initial Developer of the Original Code is Ericsson Utvecklings AB. # Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings diff --git a/lib/edoc/doc/src/Makefile b/lib/edoc/doc/src/Makefile index 1f92d36f12..ce7945a1bb 100644 --- a/lib/edoc/doc/src/Makefile +++ b/lib/edoc/doc/src/Makefile @@ -1,13 +1,14 @@ -# ``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 via the world wide web 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. +# ``Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. # # The Initial Developer of the Original Code is Ericsson Utvecklings AB. # Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings diff --git a/lib/edoc/doc/src/book.xml b/lib/edoc/doc/src/book.xml index 1a11629e6d..002bf27b94 100644 --- a/lib/edoc/doc/src/book.xml +++ b/lib/edoc/doc/src/book.xml @@ -8,16 +8,17 @@ Ericsson AB. All Rights Reserved. - 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. + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index e350adb540..289a7f00bd 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -8,16 +8,17 @@ Ericsson AB. All Rights Reserved. - 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. + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/lib/edoc/doc/src/part.xml b/lib/edoc/doc/src/part.xml index 876ae858f9..b55916823a 100644 --- a/lib/edoc/doc/src/part.xml +++ b/lib/edoc/doc/src/part.xml @@ -8,16 +8,17 @@ Ericsson AB. All Rights Reserved. - 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. + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/lib/edoc/doc/src/part_notes.xml b/lib/edoc/doc/src/part_notes.xml index 41e6c1c7f7..da3d7299f4 100644 --- a/lib/edoc/doc/src/part_notes.xml +++ b/lib/edoc/doc/src/part_notes.xml @@ -8,16 +8,17 @@ Ericsson AB. All Rights Reserved. - 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. + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/lib/edoc/doc/src/ref_man.xml b/lib/edoc/doc/src/ref_man.xml index a71b35d118..abe400d4d5 100644 --- a/lib/edoc/doc/src/ref_man.xml +++ b/lib/edoc/doc/src/ref_man.xml @@ -8,16 +8,17 @@ Ericsson AB. All Rights Reserved. - 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. + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. -- cgit v1.2.3 From 2955ddebc32837b66d9bacb4e925ad0ed0033168 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Tue, 23 Jun 2015 10:24:26 +0200 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 289a7f00bd..5260a1d465 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -32,6 +32,21 @@

    This document describes the changes made to the EDoc application.

    +
    Edoc 0.7.17 + +
    Improvements and New Features + + +

    + Remove functionality related to packages

    +

    + Own Id: OTP-12431

    +     +     +
    + +
    +
    Edoc 0.7.16
    Fixed Bugs and Malfunctions -- cgit v1.2.3 From 6945881b99aeadaf9ed4ec1f8c7811538cee1405 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:03:38 +0200 Subject: [edoc] Correct documentation Fix mistakes found by 'xmllint'. --- lib/edoc/doc/overview.edoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/overview.edoc b/lib/edoc/doc/overview.edoc index 3639bb43a5..d2bba9d744 100644 --- a/lib/edoc/doc/overview.edoc +++ b/lib/edoc/doc/overview.edoc @@ -755,7 +755,7 @@ following escape sequences may be used:
    === Function specifications === -Although the syntax described in the following can still be used +Note that although the syntax described in the following can still be used for specifying functions we recommend that Erlang specifications as described in Types and Function Specification should be added to the source @@ -764,7 +764,6 @@ marker="dialyzer:dialyzer">Dialyzer's can be utilized in the process of keeping the documentation consistent and up-to-date. Erlang specifications will be used unless there is also a function specification (a `@spec' tag followed by a type) with the same name. - The following grammar describes the form of the specifications following a `@spec' tag. A '`?'' suffix implies that the element is optional. @@ -973,12 +972,12 @@ contain any annotations at all. === Type definitions === -Although the syntax described in the following can still be used +Note that although the syntax described in the following can still be used for specifying types we recommend that Erlang types as described in Types and Function Specification should be added to the source code instead. Erlang types will be used unless there is a type alias with the same -name. +name. The following grammar (see above for auxiliary definitions) describes the form of the definitions that may follow a `@type' tag: -- cgit v1.2.3 From 0f8afe80c6582f7affd17f36dc9cb48cc7946713 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 14 Mar 2016 10:46:23 +0100 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 5260a1d465..3f9d26796a 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -32,6 +32,33 @@

    This document describes the changes made to the EDoc application.

    +
    Edoc 0.7.18 + +
    Fixed Bugs and Malfunctions + + +

    Assign correct names to list arguments.

    +

    + Own Id: OTP-13234 Aux Id: ERL-63

    +     +     +
    + + +
    Improvements and New Features + + +

    + Unless the sort_functions option is true, + edoc_layout does not sort functions.

    +

    + Own Id: OTP-13302

    +     +     +
    + +
    +
    Edoc 0.7.17
    Improvements and New Features -- cgit v1.2.3 From 6664eed554974336909d3ffe03f20349cc4c38fd Mon Sep 17 00:00:00 2001 From: Henrik Nord Date: Tue, 15 Mar 2016 15:19:56 +0100 Subject: update copyright-year --- lib/edoc/doc/src/book.xml | 2 +- lib/edoc/doc/src/notes.xml | 2 +- lib/edoc/doc/src/part.xml | 2 +- lib/edoc/doc/src/part_notes.xml | 2 +- lib/edoc/doc/src/ref_man.xml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/book.xml b/lib/edoc/doc/src/book.xml index 002bf27b94..cdd7eb6f1a 100644 --- a/lib/edoc/doc/src/book.xml +++ b/lib/edoc/doc/src/book.xml @@ -4,7 +4,7 @@
    - 20062013 + 20062016 Ericsson AB. All Rights Reserved. diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 3f9d26796a..130a5a850e 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -4,7 +4,7 @@
    - 20072013 + 20072016 Ericsson AB. All Rights Reserved. diff --git a/lib/edoc/doc/src/part.xml b/lib/edoc/doc/src/part.xml index b55916823a..389efa902b 100644 --- a/lib/edoc/doc/src/part.xml +++ b/lib/edoc/doc/src/part.xml @@ -4,7 +4,7 @@
    - 20062013 + 20062016 Ericsson AB. All Rights Reserved. diff --git a/lib/edoc/doc/src/part_notes.xml b/lib/edoc/doc/src/part_notes.xml index da3d7299f4..6a79435ff0 100644 --- a/lib/edoc/doc/src/part_notes.xml +++ b/lib/edoc/doc/src/part_notes.xml @@ -4,7 +4,7 @@
    - 20072013 + 20072016 Ericsson AB. All Rights Reserved. diff --git a/lib/edoc/doc/src/ref_man.xml b/lib/edoc/doc/src/ref_man.xml index abe400d4d5..e3460345a0 100644 --- a/lib/edoc/doc/src/ref_man.xml +++ b/lib/edoc/doc/src/ref_man.xml @@ -4,7 +4,7 @@
    - 20062013 + 20062016 Ericsson AB. All Rights Reserved. -- cgit v1.2.3 From bd64ad8e15d66e48b36dbe3584315dd5cfc8b59a Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Wed, 11 May 2016 17:22:23 +0200 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 130a5a850e..ae8147c564 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -32,6 +32,20 @@

    This document describes the changes made to the EDoc application.

    +
    Edoc 0.7.19 + +
    Improvements and New Features + + +

    Handle typed record fields.

    +

    + Own Id: OTP-13558

    +     +     +
    + +
    +
    Edoc 0.7.18
    Fixed Bugs and Malfunctions -- cgit v1.2.3 From 663e847459686604ea051f036a0e4caff18cea6f Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Thu, 12 May 2016 12:04:14 +0200 Subject: Revert "Prepare release" This reverts commit bd64ad8e15d66e48b36dbe3584315dd5cfc8b59a. --- lib/edoc/doc/src/notes.xml | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index ae8147c564..130a5a850e 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -32,20 +32,6 @@

    This document describes the changes made to the EDoc application.

    -
    Edoc 0.7.19 - -
    Improvements and New Features - - -

    Handle typed record fields.

    -

    - Own Id: OTP-13558

    -     -     -
    - -
    -
    Edoc 0.7.18
    Fixed Bugs and Malfunctions -- cgit v1.2.3 From e020f75c10410a6943cd055bfa072a2641eab7da Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Thu, 2 Jun 2016 10:55:26 +0200 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 130a5a850e..ae8147c564 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -32,6 +32,20 @@

    This document describes the changes made to the EDoc application.

    +
    Edoc 0.7.19 + +
    Improvements and New Features + + +

    Handle typed record fields.

    +

    + Own Id: OTP-13558

    +     +     +
    + +
    +
    Edoc 0.7.18
    Fixed Bugs and Malfunctions -- cgit v1.2.3 From c04cad3ba921deb086d19e2de2526af4854add75 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Thu, 2 Jun 2016 11:39:07 +0200 Subject: Revert "Prepare release" This reverts commit e020f75c10410a6943cd055bfa072a2641eab7da. --- lib/edoc/doc/src/notes.xml | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index ae8147c564..130a5a850e 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -32,20 +32,6 @@

    This document describes the changes made to the EDoc application.

    -
    Edoc 0.7.19 - -
    Improvements and New Features - - -

    Handle typed record fields.

    -

    - Own Id: OTP-13558

    -     -     -
    - -
    -
    Edoc 0.7.18
    Fixed Bugs and Malfunctions -- cgit v1.2.3 From 6e51c6d19612d03abc81b86bb70b8d7da678ce5d Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Tue, 21 Jun 2016 15:12:41 +0200 Subject: Prepare release --- lib/edoc/doc/src/notes.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'lib/edoc/doc') diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 130a5a850e..ae8147c564 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -32,6 +32,20 @@

    This document describes the changes made to the EDoc application.

    +
    Edoc 0.7.19 + +
    Improvements and New Features + + +

    Handle typed record fields.

    +

    + Own Id: OTP-13558

    +     +     +
    + +
    +
    Edoc 0.7.18
    Fixed Bugs and Malfunctions -- cgit v1.2.3
    Reference syntaxExampleScope
    `Module'{@link edoc_run}, `erl.lang.list'Global
    `Package.*'`erl.lang.*'Global
    `Function/Arity'`file/2'Within module
    `Module:Function/Arity'{@link edoc:application/2}Global
    `Type()'`filename()'Within module