aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/src
AgeCommit message (Collapse)Author
2019-02-21edoc: Print a helpful message if reading source file failsHans Bolinder
See also https://bugs.erlang.org/browse/ERL-841.
2018-06-11edoc, erl_docgen: Fix pretty-printing of type map()Hans Bolinder
Complex types including map() are now pretty-printed.
2018-05-04Fix syntactic issues in EDoc comments across some libsRadek Szymczyszyn
See https://github.com/erszcz/docsh/issues/23 for an explanation about how the files were found.
2018-04-17Do not use lists:concat where lists:append is intendedRichard Carlsson
2017-11-15Merge branch 'maint'Hans Bolinder
* maint: edoc: The map type is denoted map()
2017-11-14edoc: The map type is denoted map()Hans Bolinder
The map type was erroneously displayed as "#{}", the empty map type.
2017-10-10Merge branch 'maint'Lars Thorsen
2017-09-28[edoc] Remove unused module otpsgml_layout.erlLars Thorsen
This module was used when the OTP documentation was written in SGML. It's now replaced by code in erl_docgen and therefor removed. The option trigging the call of this module has also been removed from the script edoc_generate.
2017-09-15Merge branch 'siri/string-new-api'Siri Hansen
* siri/string-new-api: (28 commits) hipe (test): Do not use deprecated functions in string(3) dialyzer (test): Do not use deprecated functions in string(3) eunit (test): Do not use deprecated functions in string(3) system (test): Do not use deprecated functions in string(3) system (test): Do not use deprecated functions in string(3) mnesia (test): Do not use deprecated functions in string(3) Deprecate old string functions observer: Do not use deprecated functions in string(3) common_test: Do not use deprecated functions in string(3) eldap: Do not use deprecated functions in string(3) et: Do not use deprecated functions in string(3) os_mon: Do not use deprecated functions in string(3) debugger: Do not use deprecated functions in string(3) runtime_tools: Do not use deprecated functions in string(3) asn1: Do not use deprecated functions in string(3) compiler: Do not use deprecated functions in string(3) sasl: Do not use deprecated functions in string(3) reltool: Do not use deprecated functions in string(3) kernel: Do not use deprecated functions in string(3) hipe: Do not use deprecated functions in string(3) ... Conflicts: lib/eunit/src/eunit_lib.erl lib/observer/src/crashdump_viewer.erl lib/reltool/src/reltool_target.erl
2017-09-05edoc: Improve handling of UnicodeHans Bolinder
2017-09-05edoc: Improve handling of UnicodeHans Bolinder
2017-07-06edoc: Do not use deprecated functions in string(3)Hans Bolinder
2017-04-26edoc: Revert fixes for string:length/1Hans Bolinder
Reverts commits cef44e1 and 548f4e3.
2017-04-10edoc: Fix an undefined function warningHans Bolinder
Commit 15a631c introduced an undefined function warning. When the new string module is merged to master, this commit can be reverted.
2017-04-10edoc: Fix a Dialyzer warningHans Bolinder
Commit 15a631c introduced a Dialyzer warning. When the new string module is merged to master, this commit can be reverted.
2017-04-07edoc: Fix EDoc regarding Unicode atomsHans Bolinder
Also extended the scanner to handle the \x{...} syntax. Capitalizing now works with a few more characters.
2017-03-13edoc: Don't generate timestamps in footerRichard Carlsson
2017-02-14Fixed typos in lib/edocAndrew Dryga
2016-11-23Make use of the Header feature in yeccRichard Carlsson
2016-11-23Update EDoc license headers to dual Apache2/LGPLRichard Carlsson
This makes it clear that Apache 2.0 applies, without dropping the old LGPL licensing, and makes all the EDoc file headers look the same as upstream.
2016-07-07edoc: Correct typesHans Bolinder
2016-07-04edoc: Provide a slightly better fix for unmatched returnsKostis Sagonas
An attempt to shut off Dialyzer's unmatched return warnings made a change that simply ignored the return type of a function. It's arguably better to modify the code of this function to not return something "by accident." While at it, rewrote a slighty confusing use of a list comprehension without a generator to a case statement.
2016-06-09Remove support for '...' in Maps typesHans Bolinder
It is possible that '...' is added later (OTP 20.0), but for now we are not sure of all details.
2016-06-08edoc: Fix new Maps syntaxHans Bolinder
2016-05-30edoc_run: Add types and specsKostis Sagonas
2016-05-09edoc: Make EDoc work with typed record fieldsHans Bolinder
2016-03-15update copyright-yearHenrik Nord
2016-02-04Merge branch 'tnt-dev/fix-function-index-sort' into maintZandra
* tnt-dev/fix-function-index-sort: Don't sort function index when it's not necessary OTP-13302
2016-01-26[edoc] Correct documentationHans Bolinder
Fix mistakes found by 'xmllint'.
2016-01-18edoc: Assign correct names to list argumentsHans Bolinder
Bug reported by Josemic. See also ERL-63.
2015-12-14Don't sort function index when it's not necessaryPavel Abalihin
2015-06-18Change license text to APLv2Bruce Yinhe
2015-06-12edoc: Add parentheses to Erlang types and specs when neededHans Bolinder
Before OTP 18, parentheses are kept by the Erlang Parser, and converted by EDoc ('paren_type' to #t_paren{}). As of OTP 18, the parser no longer keeps parentheses, why EDoc needs to insert them when converting Erlang types and specs to EDoc types and specs. As it seems, it is only annotations that sometimes require parentheses.
2015-05-25Update runtime_dependencies in application resource filesHans Bolinder
Applications that use the new erl_anno module are depending on STDLIB 2.5. Note that CosNotification, Megaco, SNMP, Xmerl, and Parsetools use the erl_anno module via the Yecc parsers only (the header file in lib/parsetools/include/yeccpre.hrl calls the erl_anno module). HiPE does not call the erl_anno module, but uses an exported type. We have chosen to make HiPE dependent on the erl_anno module.
2015-04-30edoc: Use module erl_annoHans Bolinder
2015-03-12edoc: Correct documentationHans Bolinder
Substitute references to edoc_lib:get_doc_env/3 for references to edoc_lib:get_doc_env/4.
2015-02-23Merge branch 'richcarl/syntax_tools-remove-mnemosyne'Zandra Hird
* richcarl/syntax_tools-remove-mnemosyne: Remove Mnemosyne rules support from EDoc Remove support for Mnemosyne rules Remove support for mnemosyne-style record field access OTP-12511
2015-02-11Remove Mnemosyne rules support from EDocRichard Carlsson
2015-01-16[edoc] remove functionality related to packagesVlad Dumitrescu
The 'subpackages' option is left, since some projects use recursive source directories.
2014-09-22Merge branch 'maint'Björn-Egil Dahlberg
Conflicts: lib/stdlib/src/erl_pp.erl
2014-09-12edoc, erl_docgen: Enhance internal map type formatBjörn-Egil Dahlberg
2014-07-15Merge branch 'maint'Björn-Egil Dahlberg
2014-07-11edoc: Fix Map type information for docsBjörn-Egil Dahlberg
2014-07-02Merge branch 'maint'Magnus Lidén
2014-06-26edoc, syntax_tools: Don't fail on invalid UTF-8Hans Bolinder
As a temporary measure to ease the transition to default UTF-8 encoding, automatically fall back to the Latin-1 encoding (without any warnings; the Erlang Compiler will emit a proper warning). The intention is to remove this workaround in OTP 18 or 19.
2014-05-05[edoc] Remove pre-defined types dict(), digraph(), &cHans Bolinder
2014-04-29Modify representation of the map typeHans Bolinder
Types are represented by quadruples {type, LINE, Name, Args}, but maps were represented by five-tuples {type, LINE, map_field_assoc, Dom, Range}. Note: this is *not* about the quadruples used for representing expressions, {map_field_assoc,L,K,V}.
2014-04-29Allow more type namesHans Bolinder
product/_, union/_, range/2 as well as tuple/N (N > 0), map/N (N > 0), atom/1, integer/1, binary/2, record/_, and 'fun'/_ can now be used as type names.
2014-04-28[edoc] Handle optional behaviour callbacksHans Bolinder
2014-04-01Merge branch 'egil/maps-doc'Björn-Egil Dahlberg
* egil/maps-doc: doc: Add Maps example for sequential programming doc: Mention map expressions and map guards doc: Add maps to reference manual edoc: Add map/0 as a new predefined type doc: Descripe Maps type syntax doc: Clearify language of user-defined attributes doc: Document Maps datatype in reference manual erts: Document map guard functions erts: Fix is_map/1 spec