Age | Commit message (Collapse) | Author |
|
Most notes.xml files will be updated in every release and cause
the kind of the problems described in the previous commit.
|
|
|
|
|
|
* hb/edoc/bug_fix/OTP-10866:
[edoc] Fix a bug involving a type declaration and a comment
|
|
|
|
|
|
8115c0840527 broke building for projects that used sub directories
(but not packages).
|
|
|
|
* nox/enable-silent-rules/OTP-10726:
Implement ./otp_build configure --enable-silent-rules
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
The R15B02 release
|
|
|
|
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()).
|
|
|
|
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.
|
|
|
|
OTP-10106
OTP-10107
|
|
|
|
This reverts commit e21ff9b0b69219ab3853be7e80813156113152b7.
|
|
|
|
These dependency files was once used when building the documentation,
but are no longer needed.
|
|
Some applications still have support for an ancient documentation
build system. Eliminate the DOCSUPPORT define in otp.mk.in and the
not taken arm of the ifdefs in the Makefiles.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
* rz/add_proplist_type:
Add a proplist() type
OTP-9499
|
|
|
|
|
|
|
|
|
|
|
|
Also fixed a Dialyzer warning (edoc_wiki.erl).
|
|
|
|
Recently I was adding specs to an API and found that there is
no canonical proplist() type defined.
|
|
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.)
|
|
|
|
* hw/call-chmod-without-f:
Call chmod without the "-f" flag
Conflicts:
erts/emulator/test/Makefile
lib/asn1/test/Makefile
lib/crypto/test/Makefile
lib/debugger/test/Makefile
lib/docbuilder/test/Makefile
lib/edoc/test/Makefile
lib/erl_interface/test/Makefile
lib/inviso/test/Makefile
lib/parsetools/test/Makefile
lib/percept/test/Makefile
lib/ssl/test/Makefile
lib/syntax_tools/test/Makefile
lib/test_server/test/Makefile
lib/tools/test/Makefile
OTP-9170
|
|
* tv/edoc-loop-fix:
Fix infinite loop for malformed edoc input
OTP-9165
|
|
bmk/inets/ftp/missing_spec_causes_dialyxer_problems/OTP-9114
Also fixed a bunch of "end-years" (was 2010 but should have been 2011,
which the commit hook not happy with).
|
|
|
|
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.
|