aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/src
AgeCommit message (Collapse)Author
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
2012-06-05Update to work with whitespace in exec pathLukas Larsson
OTP-10106 OTP-10107
2011-09-25removed some never-matching clauses reported by dialyzerRichard Carlsson
2011-09-25Fix macro expansion in comments following Erlang typesHans Bolinder
Macros in comments following Erlang types were not expanded. An example: -type t() :: integer(). %% This type is used in {@link foo/0}. The link to foo/0 was not created.
2011-09-25URI-escape bytes as two hex digits always (reported by Alfonso De Gregorio)Richard Carlsson
2011-09-25updated author e-mailRichard Carlsson
2011-09-25recognize some more URI schemas in wiki text, in particular httpsRichard Carlsson
2011-08-29Merge branch 'rz/add_proplist_type' into devHenrik Nord
* rz/add_proplist_type: Add a proplist() type OTP-9499
2011-08-04forgot to ensure that xmerl is found in path for include_lib to workRichard Carlsson
2011-08-04fix -spec declaration that doesn't work in R13B04Richard Carlsson
2011-08-04eliminate warnings about unused importsRichard Carlsson
2011-08-04removed CVS-keywords from source filesRichard Carlsson
2011-08-04synchronized with edoc development versionRichard Carlsson
2011-05-31Add no_return to the built-in typesHans Bolinder
Also fixed a Dialyzer warning (edoc_wiki.erl).
2011-05-24Add a proplist() typerzezeski
Recently I was adding specs to an API and found that there is no canonical proplist() type defined.
2011-05-17Fix bugs concerning the option report_missing_typesHans Bolinder
Bugs concerning the option report_missing_types that was added in EDoc-0.7.7 have been corrected: the option was misspelled in the source, and local definitions as well as the function tags @private and @hidden were not handled correctly. (Thanks to Manolis Papadakis.)
2011-03-29Merge branch 'tv/edoc-loop-fix' into devHenrik Nord
* tv/edoc-loop-fix: Fix infinite loop for malformed edoc input OTP-9165
2011-03-10Make Erlang specifications and types available in EDocHans Bolinder
It is now possible to use Erlang specifications and types in EDoc documentation. Erlang specifications and types will be used unless there is also a function specification (@spec) or a type alias (@type) with the same name. In the current implementation the placement of -spec matters: it should be placed where the @spec would otherwise have been placed. Not all Erlang types are included in the documentation, but only those exported by some export_type declaration or used by some documented Erlang specification (-spec). There is currently no support for overloaded Erlang specifications. The syntax definitions of EDoc have been augmented to cope with most of the Erlang types. (But we recommend that Erlang types should be used instead.) edoc:read_source() takes one new option, report_missing_types. edoc_layout:module() takes one new option, pretty_printer.
2011-03-08Merge branch 'hb/edoc/wiki_encoding/OTP-9109' into devHans Bolinder
* hb/edoc/wiki_encoding/OTP-9109: Add encoding when parsing Wiki text
2011-03-07Clean up edoc_lib(3)Hans Bolinder
The <c>edoc_lib</c> module is meant to be private, but since it is referred to from other man pages it has been included in the OTP documentation. This change makes all functions private except those referred to from other pages.