From 74bb7933dfbc733e92fb5f3d23b125d3f724ee11 Mon Sep 17 00:00:00 2001 From: AeroNotix Date: Wed, 12 Jun 2013 14:13:00 +0100 Subject: [PATCH 1/4] Fixed documentation errors I fixed the documentation errors in order to get them to build I made a cursory check through the source to ensure that they were correct and it seems like they are so I submit this patch. --- src/ibrowse.erl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/ibrowse.erl b/src/ibrowse.erl index 40b3f97..5364587 100644 --- a/src/ibrowse.erl +++ b/src/ibrowse.erl @@ -481,7 +481,7 @@ spawn_worker_process(Args) -> spawn_worker_process(Args, []). %% @doc Same as spawn_worker_process/1 except with Erlang process options. -%% @spec spawn_worker_process(Url::string() | {Host::string(), Port::integer(), Options::list()) -> {ok, pid()} +%% @spec spawn_worker_process(Host::string(), Port::integer()) -> {ok, pid()} spawn_worker_process(Host, Port) when is_list(Host), is_integer(Port) -> %% Convert old API calls to new API format. spawn_worker_process({Host, Port}, []); @@ -495,7 +495,7 @@ spawn_link_worker_process(Args) -> spawn_link_worker_process(Args, []). %% @doc Same as spawn_link_worker_process/1 except with Erlang process options. -%% @spec spawn_link_worker_process(Url::string() | {Host::string(), Port::integer(), Options::list()) -> {ok, pid()} +%% @spec spawn_link_worker_process(Host::string(), Port::integer()) -> {ok, pid()} spawn_link_worker_process(Host, Port) when is_list(Host), is_integer(Port) -> %% Convert old API calls to new API format. spawn_link_worker_process({Host, Port}, []); From cc9df4fbb48e4478697a5edc92e4ecaa1e6311c2 Mon Sep 17 00:00:00 2001 From: AeroNotix Date: Wed, 12 Jun 2013 14:13:45 +0100 Subject: [PATCH 2/4] Ignore the build documentation files. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 29ee67f..62afb1e 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ ebin/ *~ .eunit/ *beam +docs/* \ No newline at end of file From b038c416c56cadad548ce4e93d8d1ac12a31b877 Mon Sep 17 00:00:00 2001 From: AeroNotix Date: Wed, 12 Jun 2013 14:18:01 +0100 Subject: [PATCH 3/4] Specify in greater detail what we want to ignore in the documentation folder. --- .gitignore | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 62afb1e..6e8057b 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,7 @@ ebin/ *~ .eunit/ *beam -docs/* \ No newline at end of file +doc/*.html +doc/*.css +doc/*.png +doc/edoc-info \ No newline at end of file From 005dcc8ad88e4f3ba0cce248d2655538d49cb3bc Mon Sep 17 00:00:00 2001 From: AeroNotix Date: Wed, 12 Jun 2013 14:18:15 +0100 Subject: [PATCH 4/4] Added a Makefile target to more easily build the documentation. There's no need for this not to be here since it's a very common operation when retrieving new dependencies. In fact, it's the first thing I did. --- Makefile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Makefile b/Makefile index 29ea9fa..63a9beb 100644 --- a/Makefile +++ b/Makefile @@ -19,3 +19,7 @@ test: all xref: all ./rebar xref + +docs: + erl -noshell \ + -eval 'edoc:application(ibrowse, ".", []), init:stop().'