aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/src
AgeCommit message (Collapse)Author
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
2014-04-01edoc: Add map/0 as a new predefined typeBjörn-Egil Dahlberg
2014-03-20Introduce runtime_dependencies in .app filesRickard Green
Most dependencies introduced are exactly the dependencies to other applications found by xref. That is, there might be real dependencies missing. There might also be pure debug dependencies listed that probably should be removed. Each application has to be manually inspected in order to ensure that all real dependencies are listed. All dependencies introduced are to application versions used in OTP 17.0. This since the previously used version scheme wasn't designed for this, and in order to minimize the work of introducing the dependencies.
2014-02-24Merge branch 'hb/dialyzer/deprecate_types/OTP-10342'Hans Bolinder
* hb/dialyzer/deprecate_types/OTP-10342: Deprecate pre-defined built-in types
2014-02-23Deprecate pre-defined built-in typesHans Bolinder
The types array(), dict(), digraph(), gb_set(), gb_tree(), queue(), set(), and tid() have been deprecated. They will be removed in OTP 18.0. Instead the types array:array(), dict:dict(), digraph:graph(), gb_set:set(), gb_tree:tree(), queue:queue(), sets:set(), and ets:tid() can be used. (Note: it has always been necessary to use ets:tid().) It is allowed in OTP 17.0 to locally re-define the types array(), dict(), and so on. New types array:array/1, dict:dict/2, gb_sets:set/1, gb_trees:tree/2, queue:queue/1, and sets:set/1 have been added.
2014-02-18Fix library application appup filesTobias Schlager
As discussed in issue #240 *all* OTP library applications use the '.*' wildcard as up and down version. This makes library applications always up- and downgradeable. Using the wildcard version obsoletes all maintenance tasks regarding library applications' appup files. Additionally, it prevents upgrade problems caused by automatically included application dependencies when using reltool to create releases. Missing copyright headers are now consistently present.
2014-02-12Fix a few of Dialyzer's unmatched_return warningsHans Bolinder
2014-01-28edoc,syntax_tools: Teach Map understandingBjörn-Egil Dahlberg
2013-04-19Remove the "coding: utf-8" comment from all Erlang source filesHans Bolinder
2013-02-20Merge branch 'hb/edoc/bug_fix/OTP-10866'Hans Bolinder
* hb/edoc/bug_fix/OTP-10866: [edoc] Fix a bug involving a type declaration and a comment
2013-02-19[edoc] Fix a bug involving a type declaration and a commentHans Bolinder
2013-02-19Use ~ts for filenamesHans Bolinder
2013-02-13edoc: Fix building of documentation in sub directoriesBjörn Gustavsson
8115c0840527 broke building for projects that used sub directories (but not packages).
2013-01-18Merge branch 'nox/enable-silent-rules/OTP-10726'Björn-Egil Dahlberg
* nox/enable-silent-rules/OTP-10726: Implement ./otp_build configure --enable-silent-rules
2013-01-15Implement ./otp_build configure --enable-silent-rulesAnthony Ramine
With silent rules, the output of make is less verbose and compilation warnings are easier to spot. Silent rules are disabled by default and can be disabled or enabled at will by make V=0 and make V=1.
2013-01-09edoc: Remove support for packagesBjörn Gustavsson
2013-01-09Prepare OTP files for Unicode as default encodingHans Bolinder
2013-01-02[edoc] Introduce Unicode support for source filesHans Bolinder
2012-08-22Fix an issue with parentheses and separate values of union typesHans Bolinder
Since EDoc 0.7.7 (R14B02) separate values of union types can be annotated. However, the parser has hitherto chosen not to add the necessary parentheses due to backwards compatibility. From this release on code traversing the output of edoc_parser needs to take care of parentheses around separate values of union types. Examples of such code are layout modules and doclet modules. The following example shows annotated values of a union type: -type t() :: (Name1 :: atom()) | (Name2 :: integer()).
2012-08-08List behaviour callbacks in Edoc when using -callback attributeMagnus Henoch
Defining a behaviour_info/1 function is no longer the only way to define a behaviour; you can use -callback attributes as well. This change makes edoc aware of the latter, such that the module documentation page for a behaviour module will list the name and arity of the required callback functions. Ideally, edoc should use the type information present in the callback attributes, but with this change, the documentation is at least no worse than when using an explicit behaviour_info function.
2012-08-08added special case for file names under Windows, thanks to Beads Land-TrujilloRichard Carlsson