| Age | Commit message (Collapse) | Author |
|---|
|
|
|
|
|
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
|
|
|
|
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.)
|
|
* tv/edoc-loop-fix:
Fix infinite loop for malformed edoc input
OTP-9165
|
|
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.
|
|
* hb/edoc/wiki_encoding/OTP-9109:
Add encoding when parsing Wiki text
|
|
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.
|
|
EDoc used to fail on strings such as "���".
Thanks to Richard Carlsson.
|
|
When processing an edoc comment with ``` in it, if the comment ends
without a matching ''' then an infinite loop occurs in the function
edoc_wiki:strip_empty_lines/2. This change fixes that by adding a clause
to return from the function upon the end of the comment input. This
allows an error to be thrown to indicate the problem, which is the same
behaviour as leaving either `` or ` unmatched.
|
|
Add appropriate specs to shut off dialyzer's no_return warnings and
also fix an erroneous use of lists:concat/1 instead of lists:append/1.
|
|
Resolve name clash with auto-imported BIF error/1.
|
|
|
|
|
|
environment after a number of bugs are fixed and some features
are added in the documentation build process.
- The arity calculation is updated.
- The module prefix used in the function names for bif's are
removed in the generated links so the links will look like
http://www.erlang.org/doc/man/erlang.html#append_element-2
instead of
http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2
- Enhanced the menu positioning in the html documentation when a
new page is loaded.
- A number of corrections in the generation of man pages (thanks
to Sergei Golovan)
- Moved some man pages to more apropriate sections, pages in
section 4 moved to 5 and pages in 6 moved to 7.
- The legal notice is taken from the xml book file so OTP's
build process can be used for non OTP applications.
|
|
|
