aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc
AgeCommit message (Collapse)Author
2012-11-23Merge branch 'maint'Björn-Egil Dahlberg
2012-11-23Update copyright yearsBjörn-Egil Dahlberg
2012-09-04Merge tag 'OTP_R15B02'Björn-Egil Dahlberg
The R15B02 release
2012-09-03Prepare releaseOTP_R15B02Erlang/OTP
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-08bumped revisionRichard Carlsson
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-12-12Prepare releaseErlang/OTP
2011-11-22Revert "Update version numbers for pre-release of R15"Björn-Egil Dahlberg
This reverts commit e21ff9b0b69219ab3853be7e80813156113152b7.
2011-11-22Update version numbers for pre-release of R15OTP_R15ABjörn Gustavsson
2011-10-27Remove unused */doc/src/make.dep filesBjörn Gustavsson
These dependency files was once used when building the documentation, but are no longer needed.
2011-10-27doc Makefiles: Eliminate DOCSUPPORT ifdefsBjörn Gustavsson
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.
2011-10-04Prepare releaseOTP_R14B04Erlang/OTP
2011-09-25bumped revisionRichard Carlsson
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-24Prepare releaseOTP_R14B03Erlang/OTP
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-04-06Merge branch 'dev' into bmk/inets/inet56_integrationMicael Karlberg
2011-03-30Merge branch 'hw/call-chmod-without-f' into devHenrik Nord
* 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
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-17Merge branch 'dev' into ↵Micael Karlberg
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).
2011-03-14Prepare releaseOTP_R14B02Erlang/OTP
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.
2011-03-07Add encoding when parsing Wiki textHans Bolinder
EDoc used to fail on strings such as "���". Thanks to Richard Carlsson.
2011-02-17Rename Suite Callback to Common Test HookLukas Larsson
2011-02-17Update and add cover spec files to work with common_testLukas Larsson
2011-02-17Update all test specsLukas Larsson
2011-02-17Fix formatting for edocLukas Larsson
2011-02-17Add init_per_suite and end_per_suiteLukas Larsson
2011-02-17Add ts_install_scb to suite/0Lukas Larsson
2011-02-17Update edoc tests to conform with common_test standardLukas Larsson
2011-02-01Fix infinite loop for malformed edoc inputTaylor Venable
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.
2010-12-06Prepare releaseErlang/OTP
2010-11-15Fix various dialyzer warningsKostis Sagonas
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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 08:19:33 +0000