From d11d6acb3cea2cb750b69e23811b31f6248aac80 Mon Sep 17 00:00:00 2001 From: Richard Carlsson Date: Tue, 2 Aug 2011 21:55:33 +0200 Subject: recognize some more URI schemas in wiki text, in particular https --- lib/edoc/src/edoc_wiki.erl | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/lib/edoc/src/edoc_wiki.erl b/lib/edoc/src/edoc_wiki.erl index 2f2d14853c..33e687fe63 100644 --- a/lib/edoc/src/edoc_wiki.erl +++ b/lib/edoc/src/edoc_wiki.erl @@ -249,10 +249,20 @@ expand_triple([], L, _, L0) -> expand_uri("http:/" ++ Cs, L, As) -> expand_uri(Cs, L, "/:ptth", As); +expand_uri("https:/" ++ Cs, L, As) -> + expand_uri(Cs, L, "/:sptth", As); expand_uri("ftp:/" ++ Cs, L, As) -> expand_uri(Cs, L, "/:ptf", As); expand_uri("file:/" ++ Cs, L, As) -> expand_uri(Cs, L, "/:elif", As); +expand_uri("mailto:/" ++ Cs, L, As) -> + expand_uri(Cs, L, "/:otliam", As); +expand_uri("nfs:/" ++ Cs, L, As) -> + expand_uri(Cs, L, "/:sfn", As); +expand_uri("shttp:/" ++ Cs, L, As) -> + expand_uri(Cs, L, "/:ptths", As); +expand_uri("xmpp:/" ++ Cs, L, As) -> + expand_uri(Cs, L, "/:ppmx", As); expand_uri(Cs, L, As) -> expand(Cs, L, [$[ | As]). -- cgit v1.2.3 From 766d0f0b20d672e90f2672c6b4b9a441497f5ea5 Mon Sep 17 00:00:00 2001 From: Richard Carlsson Date: Sat, 6 Aug 2011 16:55:07 +0200 Subject: updated author e-mail --- lib/edoc/doc/overview.edoc | 8 ++++---- lib/edoc/include/edoc_doclet.hrl | 2 +- lib/edoc/src/edoc.erl | 2 +- lib/edoc/src/edoc.hrl | 2 +- lib/edoc/src/edoc_data.erl | 2 +- lib/edoc/src/edoc_doclet.erl | 2 +- lib/edoc/src/edoc_extract.erl | 2 +- lib/edoc/src/edoc_layout.erl | 2 +- lib/edoc/src/edoc_lib.erl | 2 +- lib/edoc/src/edoc_macros.erl | 2 +- lib/edoc/src/edoc_parser.yrl | 4 ++-- lib/edoc/src/edoc_refs.erl | 2 +- lib/edoc/src/edoc_report.erl | 2 +- lib/edoc/src/edoc_run.erl | 2 +- lib/edoc/src/edoc_scanner.erl | 2 +- lib/edoc/src/edoc_tags.erl | 2 +- lib/edoc/src/edoc_types.erl | 2 +- lib/edoc/src/edoc_types.hrl | 2 +- lib/edoc/src/edoc_wiki.erl | 2 +- lib/edoc/src/otpsgml_layout.erl | 2 +- 20 files changed, 24 insertions(+), 24 deletions(-) diff --git a/lib/edoc/doc/overview.edoc b/lib/edoc/doc/overview.edoc index fa699c6f08..2af425272e 100644 --- a/lib/edoc/doc/overview.edoc +++ b/lib/edoc/doc/overview.edoc @@ -3,7 +3,7 @@ EDoc overview page -@author Richard Carlsson +@author Richard Carlsson @copyright 2003-2006 Richard Carlsson @version {@version} @title Welcome to EDoc @@ -277,12 +277,12 @@ The following tags can be used before a module declaration: Examples: ```%% @author Richard Carlsson''' -```%% @author Richard Carlsson +```%% @author Richard Carlsson %% [http://user.it.uu.se/~richardc/]''' -```%% @author ''' +```%% @author ''' -```%% @author richardc@it.uu.se [http://user.it.uu.se/~richardc/]''' +```%% @author carlsson.richard@gmail.com [http://user.it.uu.se/~richardc/]'''
`@copyright'
diff --git a/lib/edoc/include/edoc_doclet.hrl b/lib/edoc/include/edoc_doclet.hrl index a99ff1fbab..60ec7f44e4 100644 --- a/lib/edoc/include/edoc_doclet.hrl +++ b/lib/edoc/include/edoc_doclet.hrl @@ -18,7 +18,7 @@ %% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 %% USA %% -%% Author contact: richardc@it.uu.se +%% Author contact: carlsson.richard@gmail.com %% ===================================================================== -define(NO_APP, []). diff --git a/lib/edoc/src/edoc.erl b/lib/edoc/src/edoc.erl index a279f7dcb3..544465b14a 100644 --- a/lib/edoc/src/edoc.erl +++ b/lib/edoc/src/edoc.erl @@ -15,7 +15,7 @@ %% USA %% %% @copyright 2001-2007 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @version {@version} %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc.hrl b/lib/edoc/src/edoc.hrl index 31cf45ade9..98debba4ab 100644 --- a/lib/edoc/src/edoc.hrl +++ b/lib/edoc/src/edoc.hrl @@ -18,7 +18,7 @@ %% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 %% USA %% -%% Author contact: richardc@it.uu.se +%% Author contact: carlsson.richard@gmail.com %% ===================================================================== %% Note: Documentation in this file is included by edoc_extract.erl diff --git a/lib/edoc/src/edoc_data.erl b/lib/edoc/src/edoc_data.erl index e3b5a0d51b..aad0b14371 100644 --- a/lib/edoc/src/edoc_data.erl +++ b/lib/edoc/src/edoc_data.erl @@ -16,7 +16,7 @@ %% %% @private %% @copyright 2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_doclet.erl b/lib/edoc/src/edoc_doclet.erl index c66be9d7c7..385d20e9ae 100644 --- a/lib/edoc/src/edoc_doclet.erl +++ b/lib/edoc/src/edoc_doclet.erl @@ -15,7 +15,7 @@ %% USA %% %% @copyright 2003-2006 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_extract.erl b/lib/edoc/src/edoc_extract.erl index 1209d86fe5..bdda09db1c 100644 --- a/lib/edoc/src/edoc_extract.erl +++ b/lib/edoc/src/edoc_extract.erl @@ -15,7 +15,7 @@ %% USA %% %% @copyright 2001-2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_layout.erl b/lib/edoc/src/edoc_layout.erl index 1c0841815f..951cec121c 100644 --- a/lib/edoc/src/edoc_layout.erl +++ b/lib/edoc/src/edoc_layout.erl @@ -14,7 +14,7 @@ %% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 %% USA %% -%% @author Richard Carlsson +%% @author Richard Carlsson %% @copyright 2001-2006 Richard Carlsson %% @see edoc %% @end diff --git a/lib/edoc/src/edoc_lib.erl b/lib/edoc/src/edoc_lib.erl index 6c698e83ef..df929ebf04 100644 --- a/lib/edoc/src/edoc_lib.erl +++ b/lib/edoc/src/edoc_lib.erl @@ -15,7 +15,7 @@ %% USA %% %% @copyright 2001-2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_macros.erl b/lib/edoc/src/edoc_macros.erl index 5b512cb53a..70fb38bf0a 100644 --- a/lib/edoc/src/edoc_macros.erl +++ b/lib/edoc/src/edoc_macros.erl @@ -16,7 +16,7 @@ %% %% @private %% @copyright 2001-2005 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_parser.yrl b/lib/edoc/src/edoc_parser.yrl index 3ce4cde4fb..2871846c04 100644 --- a/lib/edoc/src/edoc_parser.yrl +++ b/lib/edoc/src/edoc_parser.yrl @@ -22,7 +22,7 @@ %% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 %% USA %% -%% Author contact: richardc@it.uu.se +%% Author contact: carlsson.richard@gmail.com %% ===================================================================== Nonterminals @@ -255,7 +255,7 @@ throws -> etype where_defs: %% "%% USA" %% "%%" %% "%% @private" -%% "%% @author Richard Carlsson " +%% "%% @author Richard Carlsson " %% "%% ====================================================================" %% . diff --git a/lib/edoc/src/edoc_refs.erl b/lib/edoc/src/edoc_refs.erl index b974cf77c1..1f578a3b83 100644 --- a/lib/edoc/src/edoc_refs.erl +++ b/lib/edoc/src/edoc_refs.erl @@ -16,7 +16,7 @@ %% %% @private %% @copyright 2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @see edoc_parse_ref %% @end diff --git a/lib/edoc/src/edoc_report.erl b/lib/edoc/src/edoc_report.erl index f082513bee..9bec08ab97 100644 --- a/lib/edoc/src/edoc_report.erl +++ b/lib/edoc/src/edoc_report.erl @@ -16,7 +16,7 @@ %% %% @private %% @copyright 2001-2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_run.erl b/lib/edoc/src/edoc_run.erl index 1355db840f..48b6137ac1 100644 --- a/lib/edoc/src/edoc_run.erl +++ b/lib/edoc/src/edoc_run.erl @@ -15,7 +15,7 @@ %% USA %% %% @copyright 2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_scanner.erl b/lib/edoc/src/edoc_scanner.erl index 8e895ad1ad..754fcef643 100644 --- a/lib/edoc/src/edoc_scanner.erl +++ b/lib/edoc/src/edoc_scanner.erl @@ -16,7 +16,7 @@ %% @private %% @copyright Richard Carlsson 2001-2003. Portions created by Ericsson %% are Copyright 1999, Ericsson Utvecklings AB. All Rights Reserved. -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end diff --git a/lib/edoc/src/edoc_tags.erl b/lib/edoc/src/edoc_tags.erl index 80989428ce..2d986988c2 100644 --- a/lib/edoc/src/edoc_tags.erl +++ b/lib/edoc/src/edoc_tags.erl @@ -16,7 +16,7 @@ %% %% @private %% @copyright 2001-2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_types.erl b/lib/edoc/src/edoc_types.erl index a54544868c..60c6cecb97 100644 --- a/lib/edoc/src/edoc_types.erl +++ b/lib/edoc/src/edoc_types.erl @@ -16,7 +16,7 @@ %% %% @private %% @copyright 2001-2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/edoc_types.hrl b/lib/edoc/src/edoc_types.hrl index 1353bfb93a..05c61d70ff 100644 --- a/lib/edoc/src/edoc_types.hrl +++ b/lib/edoc/src/edoc_types.hrl @@ -18,7 +18,7 @@ %% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 %% USA %% -%% Author contact: richardc@it.uu.se +%% Author contact: carlsson.richard@gmail.com %% ===================================================================== %% Type specification data structures diff --git a/lib/edoc/src/edoc_wiki.erl b/lib/edoc/src/edoc_wiki.erl index 33e687fe63..5c71658af5 100644 --- a/lib/edoc/src/edoc_wiki.erl +++ b/lib/edoc/src/edoc_wiki.erl @@ -16,7 +16,7 @@ %% %% @private %% @copyright 2001-2003 Richard Carlsson -%% @author Richard Carlsson +%% @author Richard Carlsson %% @see edoc %% @end %% ===================================================================== diff --git a/lib/edoc/src/otpsgml_layout.erl b/lib/edoc/src/otpsgml_layout.erl index d425dc0ed8..2c4cd919bb 100644 --- a/lib/edoc/src/otpsgml_layout.erl +++ b/lib/edoc/src/otpsgml_layout.erl @@ -14,7 +14,7 @@ %% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 %% USA %% -%% @author Richard Carlsson +%% @author Richard Carlsson %% @author Kenneth Lundin %% @copyright 2001-2004 Richard Carlsson %% @see edoc_layout -- cgit v1.2.3 From 10f76823b8c71ecc84f51bf9f93514d6d25a4a77 Mon Sep 17 00:00:00 2001 From: Richard Carlsson Date: Thu, 18 Aug 2011 14:32:36 +0200 Subject: URI-escape bytes as two hex digits always (reported by Alfonso De Gregorio) --- lib/edoc/src/edoc_lib.erl | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/lib/edoc/src/edoc_lib.erl b/lib/edoc/src/edoc_lib.erl index df929ebf04..7fd8358add 100644 --- a/lib/edoc/src/edoc_lib.erl +++ b/lib/edoc/src/edoc_lib.erl @@ -403,8 +403,13 @@ escape_uri([C | Cs]) -> escape_uri([]) -> []. -escape_byte(C) -> - "%" ++ hex_octet(C). +escape_byte(C) when C >= 0, C =< 255 -> + [$%, hex_digit(C bsr 4), hex_digit(C band 15)]. + +hex_digit(N) when N >= 0, N =< 9 -> + N + $0; +hex_digit(N) when N > 9, N =< 15 -> + N + $a - 10. % utf8([C | Cs]) when C > 16#7f -> % [((C band 16#c0) bsr 6) + 16#c0, C band 16#3f ++ 16#80 | utf8(Cs)]; @@ -413,13 +418,6 @@ escape_byte(C) -> % utf8([]) -> % []. -hex_octet(N) when N =< 9 -> - [$0 + N]; -hex_octet(N) when N > 15 -> - hex_octet(N bsr 4) ++ hex_octet(N band 15); -hex_octet(N) -> - [N - 10 + $a]. - %% Please note that URI are *not* file names. Don't use the stdlib %% 'filename' module for operations on (any parts of) URI. -- cgit v1.2.3 From 530d3b1c4b242d31fa035a3d3865ced2576ef1bb Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Wed, 24 Aug 2011 14:38:01 +0200 Subject: Fix macro expansion in comments following Erlang types 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. --- lib/edoc/src/edoc_extract.erl | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/lib/edoc/src/edoc_extract.erl b/lib/edoc/src/edoc_extract.erl index bdda09db1c..5a79e127f6 100644 --- a/lib/edoc/src/edoc_extract.erl +++ b/lib/edoc/src/edoc_extract.erl @@ -75,7 +75,7 @@ source(Forms, Comments, File, Env, Opts) when is_list(Forms) -> source(Forms1, Comments, File, Env, Opts); source(Forms, Comments, File, Env, Opts) -> Tree = erl_recomment:quick_recomment_forms(Forms, Comments), - TypeDocs = find_type_docs(Forms, Comments), + TypeDocs = find_type_docs(Forms, Comments, Env, File), source1(Tree, File, Env, Opts, TypeDocs). %% @spec source(Forms, File::filename(), Env::edoc_env(), @@ -111,7 +111,7 @@ source(Forms, Comments, File, Env, Opts) -> source(Forms, File, Env, Opts) when is_list(Forms) -> source(erl_syntax:form_list(Forms), File, Env, Opts); source(Tree, File0, Env, Opts) -> - TypeDocs = find_type_docs(Tree, []), + TypeDocs = find_type_docs(Tree, [], Env, File0), source1(Tree, File0, Env, Opts, TypeDocs). %% Forms0 and Comments is used for extracting Erlang type documentation. @@ -635,14 +635,17 @@ file_macros(_Context, Env) -> %% The same thing using -type: %% -type t() :: t1(). % Some docs of t/0; %% Further docs of t/0. -find_type_docs(Forms0, Comments) -> +find_type_docs(Forms0, Comments, Env, File) -> Tree = erl_recomment:recomment_forms(Forms0, Comments), Forms = preprocess_forms(Tree), - edoc_specs:docs(Forms, fun find_fun/2). + Env1 = add_macro_defs(edoc_macros:std_macros(Env), [], Env), + F = fun(C, Line) -> find_fun(C, Line, Env1, File) end, + edoc_specs:docs(Forms, F). -find_fun(C0, Line) -> +find_fun(C0, Line, Env, File) -> C1 = comment_text(C0), Text = lists:append([C#comment.text || C <- C1]), Comm = #comment{line = Line, text = Text}, [Tag | _] = scan_tags([Comm]), - Tag. + [Tag1] = edoc_macros:expand_tags([Tag], Env, File), + Tag1. -- cgit v1.2.3 From 823f01895f33e559d737880d9207054a20dcc2f8 Mon Sep 17 00:00:00 2001 From: Richard Carlsson Date: Fri, 23 Sep 2011 22:19:10 +0200 Subject: removed some never-matching clauses reported by dialyzer --- lib/edoc/src/edoc_parser.yrl | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/lib/edoc/src/edoc_parser.yrl b/lib/edoc/src/edoc_parser.yrl index 2871846c04..4d6428f75b 100644 --- a/lib/edoc/src/edoc_parser.yrl +++ b/lib/edoc/src/edoc_parser.yrl @@ -455,8 +455,6 @@ parse_throws(S, L) -> -spec throw_error(term(), erl_scan:line()) -> no_return(). -throw_error({L, M, D}, _L0) -> - throw({error,L,{format_error,M,D}}); throw_error({parse_spec, E}, L) -> throw_error({"specification", E}, L); throw_error({parse_typedef, E}, L) -> @@ -468,7 +466,4 @@ throw_error({parse_throws, E}, L) -> throw_error(parse_param, L) -> throw({error, L, "missing parameter name"}); throw_error({Where, E}, L) when is_list(Where) -> - throw({error,L,{"unknown error parsing ~s: ~P.",[Where,E,15]}}); -throw_error(E, L) -> - %% Just in case. - throw({error,L,{"unknown parse error: ~P.",[E,15]}}). + throw({error,L,{"unknown error parsing ~s: ~P.",[Where,E,15]}}). -- cgit v1.2.3 From df2063c1e436cfb2bb9283df074c4eaa87aeec91 Mon Sep 17 00:00:00 2001 From: Richard Carlsson Date: Sun, 25 Sep 2011 20:33:33 +0200 Subject: bumped revision --- lib/edoc/vsn.mk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/edoc/vsn.mk b/lib/edoc/vsn.mk index 30cf191ffc..22f225dd9b 100644 --- a/lib/edoc/vsn.mk +++ b/lib/edoc/vsn.mk @@ -1 +1 @@ -EDOC_VSN = 0.7.8 +EDOC_VSN = 0.7.9 -- cgit v1.2.3