From 341bd39f8c3b09b9fdaddbdadce42e80a2b3060d Mon Sep 17 00:00:00 2001 From: Vlad Dumitrescu Date: Mon, 17 Nov 2014 12:05:47 +0100 Subject: [edoc] add test for nested source directories --- lib/edoc/test/edoc_SUITE.erl | 21 +++++++++++++++++++-- lib/edoc/test/edoc_SUITE_data/myapp/doc/.dummy | 0 lib/edoc/test/edoc_SUITE_data/myapp/src/a.erl | 1 + lib/edoc/test/edoc_SUITE_data/myapp/src/src_1/b.erl | 1 + 4 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 lib/edoc/test/edoc_SUITE_data/myapp/doc/.dummy create mode 100644 lib/edoc/test/edoc_SUITE_data/myapp/src/a.erl create mode 100644 lib/edoc/test/edoc_SUITE_data/myapp/src/src_1/b.erl (limited to 'lib') diff --git a/lib/edoc/test/edoc_SUITE.erl b/lib/edoc/test/edoc_SUITE.erl index c63660c8c0..3b2774434b 100644 --- a/lib/edoc/test/edoc_SUITE.erl +++ b/lib/edoc/test/edoc_SUITE.erl @@ -22,12 +22,12 @@ init_per_group/2,end_per_group/2]). %% Test cases --export([app/1,appup/1,build_std/1,build_map_module/1,otp_12008/1]). +-export([app/1,appup/1,build_std/1,build_map_module/1,otp_12008/1, build_app/1]). suite() -> [{ct_hooks,[ts_install_cth]}]. all() -> - [app,appup,build_std,build_map_module,otp_12008]. + [app,appup,build_std,build_map_module,otp_12008, build_app]. groups() -> []. @@ -95,3 +95,20 @@ otp_12008(Config) when is_list(Config) -> ok = edoc:files([Un2], Opts2), {'EXIT', error} = (catch edoc:files([Un3], Opts2)), ok. + +build_app(suite) -> []; +build_app(doc) -> ["Build a local app with nested source directories"]; +build_app(Config) -> + DataDir = ?config(data_dir, Config), + PrivDir = ?config(priv_dir, Config), + OutDir = filename:join(PrivDir, "myapp"), + Src = filename:join(DataDir, "myapp"), + + ok = edoc:application(myapp, Src, [{dir, OutDir}, {packages, false}, {subpackages, false}]), + true = filelib:is_regular(filename:join(OutDir, "a.html")), + false = filelib:is_regular(filename:join(OutDir, "b.html")), + + ok = edoc:application(myapp, Src, [{dir, OutDir}, {packages, false}]), + true = filelib:is_regular(filename:join(OutDir, "a.html")), + true = filelib:is_regular(filename:join(OutDir, "b.html")), + ok. diff --git a/lib/edoc/test/edoc_SUITE_data/myapp/doc/.dummy b/lib/edoc/test/edoc_SUITE_data/myapp/doc/.dummy new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/edoc/test/edoc_SUITE_data/myapp/src/a.erl b/lib/edoc/test/edoc_SUITE_data/myapp/src/a.erl new file mode 100644 index 0000000000..1b5b704551 --- /dev/null +++ b/lib/edoc/test/edoc_SUITE_data/myapp/src/a.erl @@ -0,0 +1 @@ +-module(a). diff --git a/lib/edoc/test/edoc_SUITE_data/myapp/src/src_1/b.erl b/lib/edoc/test/edoc_SUITE_data/myapp/src/src_1/b.erl new file mode 100644 index 0000000000..6d6f15dfe5 --- /dev/null +++ b/lib/edoc/test/edoc_SUITE_data/myapp/src/src_1/b.erl @@ -0,0 +1 @@ +-module(b). -- cgit v1.2.3 From 6f492b98505ee6d68b9f438915dfbd3616a1b729 Mon Sep 17 00:00:00 2001 From: Vlad Dumitrescu Date: Fri, 16 Jan 2015 09:39:31 +0100 Subject: [edoc] remove functionality related to packages The 'subpackages' option is left, since some projects use recursive source directories. --- lib/edoc/doc/overview.edoc | 23 +--- lib/edoc/include/edoc_doclet.hrl | 11 +- lib/edoc/priv/edoc.dtd | 9 +- lib/edoc/priv/stylesheet.css | 4 +- lib/edoc/src/edoc.erl | 174 +++++++------------------- lib/edoc/src/edoc.hrl | 7 +- lib/edoc/src/edoc_data.erl | 33 +---- lib/edoc/src/edoc_doclet.erl | 106 +++------------- lib/edoc/src/edoc_extract.erl | 8 +- lib/edoc/src/edoc_layout.erl | 26 +--- lib/edoc/src/edoc_lib.erl | 157 +++++++++-------------- lib/edoc/src/edoc_macros.erl | 4 - lib/edoc/src/edoc_parser.yrl | 10 +- lib/edoc/src/edoc_refs.erl | 72 +---------- lib/edoc/src/edoc_run.erl | 30 +---- lib/edoc/src/edoc_tags.erl | 22 ++-- lib/edoc/src/otpsgml_layout.erl | 24 +--- lib/edoc/test/edoc_SUITE.erl | 4 +- lib/erl_docgen/priv/bin/specs_gen.escript | 2 +- lib/erl_docgen/priv/bin/xml_from_edoc.escript | 2 +- 20 files changed, 165 insertions(+), 563 deletions(-) (limited to 'lib') diff --git a/lib/edoc/doc/overview.edoc b/lib/edoc/doc/overview.edoc index 2af425272e..0ced8cab32 100644 --- a/lib/edoc/doc/overview.edoc +++ b/lib/edoc/doc/overview.edoc @@ -76,8 +76,6 @@ The following are the main functions for running EDoc: