From a2bd3485ec24e67d5a28dbd7cfc94bd852dc4a2b Mon Sep 17 00:00:00 2001 From: benoitc Date: Fri, 6 Nov 2015 11:43:01 +0100 Subject: [PATCH] update doc --- doc/edoc-info | 4 ++ doc/erlang.png | Bin 0 -> 2109 bytes doc/ibrowse_app.html | 38 ++++++++++++++ doc/ibrowse_http_client.html | 98 +++++++++++++++++++++++++++++++++++ doc/ibrowse_lb.html | 80 ++++++++++++++++++++++++++++ doc/ibrowse_socks5.html | 31 +++++++++++ doc/ibrowse_sup.html | 38 ++++++++++++++ doc/index.html | 17 ++++++ doc/modules-frame.html | 18 +++++++ doc/overview-summary.html | 16 ++++++ doc/stylesheet.css | 55 ++++++++++++++++++++ 11 files changed, 395 insertions(+) create mode 100644 doc/edoc-info create mode 100644 doc/erlang.png create mode 100644 doc/ibrowse_app.html create mode 100644 doc/ibrowse_http_client.html create mode 100644 doc/ibrowse_lb.html create mode 100644 doc/ibrowse_socks5.html create mode 100644 doc/ibrowse_sup.html create mode 100644 doc/index.html create mode 100644 doc/modules-frame.html create mode 100644 doc/overview-summary.html create mode 100644 doc/stylesheet.css diff --git a/doc/edoc-info b/doc/edoc-info new file mode 100644 index 0000000..8d400b5 --- /dev/null +++ b/doc/edoc-info @@ -0,0 +1,4 @@ +%% encoding: UTF-8 +{application,ibrowse}. +{modules,[ibrowse,ibrowse_app,ibrowse_http_client,ibrowse_lb,ibrowse_lib, + ibrowse_socks5,ibrowse_sup]}. diff --git a/doc/erlang.png b/doc/erlang.png new file mode 100644 index 0000000000000000000000000000000000000000..987a618e2403af895bfaf8c2f929e3a4f3746659 GIT binary patch literal 2109 zcmV-D2*US?P)rez_nr%N ze)-p~%6|a|LA_bA=l=$|3jjqS$tjbGG?@TN0w$Azq7Z{YeQxKcpLO55vno1^u23DP&V=i9-KAAsU*ECy^#OtaDC!lVSo!+|-%T+LhTHP^Oqwx8m)b4r3V28JmV&6M#iG)&0;P`j>XGfomEIEK6wPkhI{{K?3#uAGq$!`N_F)TNX zAvuspF?^;c9h%CPWyTDc_03%r4N8+Yzzo_VSfa!zo_7F6D?<+-+KkHwXiWQR=Mr(9|K@{{xEjfDvAbS9uNCP&{)NNCoC?XA$aRe>R8-> z5N<#S_)$d|EYpJfPC?{`$Y~f4yjH&dxHXIGG8wiaLBD6usC87cg+dd&3WLJd4_TcmEeAOz8R>ikgW(9821 z{34Se09Y?KoG<_Y;DDSoyTk>fUN0YO5)3^Za{&s1JbidC9}56{px+f|K_0;YuL5h} z_9J3y%7ucwM)E4K#=Cn7tCjjRkKjnQuiFcM6{17Jt#5F}7z8~RYqW24xV?kAU6xQN zh+h4|SmO1;TdsVOaOeD*kKf}6I7=6ZNig_rtqV?Ov1HrU(P%Hi#6npSe>%qGaNK1w zW$v+r`r0>#p~AN^8b)#7Yesu(ys(>3SCYb4sF9%A9=kMHrLmzk}E&WPG~Jx z9!r{qo5M184t;<7I`t1AsNjv912EeKkHKtOSl%wbcjFh7L6|G?Q+{?radOvuEW$>1 zoc+c&F+u$^0f}1_2dN&lS#I#p3e&+|YGHlMzRC)%&8TnGt+p*;Oz z`0=D=n|qcN+f@07;QjB@ktLhZ`+qz;(xYDli^Pex&&wwU2V4N-a3b@veqHg2cvCRb zoi=ZerLk!4t5!s3?|ARuWx_4-VCgl|TY2qa@$Dr~5QdiT8?$oPpZhaF5UOZ&x=+I9 zt((`6wBPM((BS{;2lmSB;o%z{>=mg*1k2oLjI=+zcf5$4BIZmkOrjrE z*VY(<@FO?zBVDc+Q~Lh;LnlYodZ$J3tmWJBN4j~wVOWelzexhft2nY6A3PZAcm!q} z931CL#1Ki6;HM{agTbKF>3(R-yuF1&Apn3Nh@PGvv)K$mkVqu*^z@vaFgQ3kFfg!s z^=f26@{Ny=_w@7x1qHF$bEk5X$)wR}0s{l>V!TCGM=R5Ei1Ll8u7Z*N0G1CPgB zyLPP|0H{-FRUDJv`Ea=9fX zC63D4+FBlumz$eAJv~j5q*|@^_xC?_>XiL0K@bH61$;i=&CLx(QGb8`8#iu{BnjJW zHUvSgUcK7T&~W(h;koN8t5vB~Ha0dgnane1&RA#87dVcaOpEMM)6>)E&YiPZEXBpe zlarHk89g;+G#U#E3hL_W002xT6UTApOeR%UR_5g7q^73!_4PG2Hi|@|ii(Pfi3vIY z0ES^?Mx1IOizO0?e0_a!9483k`PtCk-rm~Unwpw=?b@~O?(WdgP^bMMAYlLg{dIM9 zOy}OcxVTs%k(@q#n$PF+`TXkYYA%;cr_*5ofWcr$PEL-Ai772Db)3`L*|~G)&eqn} zq@*OrbXim`UAiO`3XdK=%H#1=D%HHV>FMbqAtCAM=@!e}C6Cc))ai5zg~H3rYjkup zD=RBMKR+`wv!kN}1^{3fR#a3}RaLcP#}20|H!^bT)~%G3lp{xu!0_{Wr2hW?>({UQ z`T1F`)|D$)*3{IP&1UDKhLn_)sMYHH{QRkzV=$M?#W2idGFh!wf*`b7ZGC-xVPT=c zV1Vs&!otFoN~M>VQ$G_G6}5No-m0pqwzjr;?W@INu~;m#k*%qz(P%VUt#;3zJ^lUt zU0q%G?%kVzvF7cqQmLw|tA~e&XIqun*x2Ug=9-!s48ty7ycil9Di(|7aybkD7#y?%lgQ z9`Ewy%eDpgxlvJ3Cr+GTFc>(F+cg;(8TPc>y?b|jeEgLwR}LLIBoqp1+1c4_HrvO? z$J5g@G&D3gIC$2ITrQ7`iwh4AfA;K|OePZu1oriTVVG1Zl}e@S)~)mK@UU1cI-Ty| z!Gj8gg2UmUD2ibif*{e+(R4bU#bU|j@{Joe^7(uSf+8X!q*7@_M1;L=AqbM3oXp{H nT3T9A6wS=c+_!HZolgHhw9g$%O4Wbp00000NkvXXu0mjf3HKBY literal 0 HcmV?d00001 diff --git a/doc/ibrowse_app.html b/doc/ibrowse_app.html new file mode 100644 index 0000000..368a4b3 --- /dev/null +++ b/doc/ibrowse_app.html @@ -0,0 +1,38 @@ + + + + +Module ibrowse_app + + + +
Overviewerlang logo
+
+ +

Module ibrowse_app

+ + +

Behaviours: application.

+ +

Function Index

+ + +
start/2
stop/1
+ +

Function Details

+ +

start/2

+
+

start(Type, StartArgs) -> any()

+
+ +

stop/1

+
+

stop(State) -> any()

+
+
+ +
Overviewerlang logo
+

Generated by EDoc, Nov 6 2015, 11:40:24.

+ + diff --git a/doc/ibrowse_http_client.html b/doc/ibrowse_http_client.html new file mode 100644 index 0000000..66f0f53 --- /dev/null +++ b/doc/ibrowse_http_client.html @@ -0,0 +1,98 @@ + + + + +Module ibrowse_http_client + + + +
Overviewerlang logo
+
+ +

Module ibrowse_http_client

+ + +

Behaviours: gen_server.

+ +

Function Index

+ + + + + + + + + + + + +
code_change/3
handle_call/3
handle_cast/2
handle_info/2
init/1
send_req/7
start/1
start/2
start_link/1
start_link/2
stop/1
terminate/2
+ +

Function Details

+ +

code_change/3

+
+

code_change(OldVsn, State, Extra) -> any()

+
+ +

handle_call/3

+
+

handle_call(Request, From, State) -> any()

+
+ +

handle_cast/2

+
+

handle_cast(Msg, State) -> any()

+
+ +

handle_info/2

+
+

handle_info(Info, State) -> any()

+
+ +

init/1

+
+

init(Url) -> any()

+
+ +

send_req/7

+
+

send_req(Conn_Pid, Url, Headers, Method, Body, Options, Timeout) -> any()

+
+ +

start/1

+
+

start(Args) -> any()

+
+ +

start/2

+
+

start(Args, Options) -> any()

+
+ +

start_link/1

+
+

start_link(Args) -> any()

+
+ +

start_link/2

+
+

start_link(Args, Options) -> any()

+
+ +

stop/1

+
+

stop(Conn_pid) -> any()

+
+ +

terminate/2

+
+

terminate(Reason, State) -> any()

+
+
+ +
Overviewerlang logo
+

Generated by EDoc, Nov 6 2015, 11:40:24.

+ + diff --git a/doc/ibrowse_lb.html b/doc/ibrowse_lb.html new file mode 100644 index 0000000..b115982 --- /dev/null +++ b/doc/ibrowse_lb.html @@ -0,0 +1,80 @@ + + + + +Module ibrowse_lb + + + +
Overviewerlang logo
+
+ +

Module ibrowse_lb

+ + +

Behaviours: gen_server.

+ +

Function Index

+ + + + + + + + + +
code_change/3
handle_call/3
handle_cast/2
handle_info/2
init/1
spawn_connection/6
start_link/1
stop/1
terminate/2
+ +

Function Details

+ +

code_change/3

+
+

code_change(OldVsn, State, Extra) -> any()

+
+ +

handle_call/3

+
+

handle_call(Request, From, State) -> any()

+
+ +

handle_cast/2

+
+

handle_cast(Msg, State) -> any()

+
+ +

handle_info/2

+
+

handle_info(Info, State) -> any()

+
+ +

init/1

+
+

init(X1) -> any()

+
+ +

spawn_connection/6

+
+

spawn_connection(Lb_pid, Url, Max_sessions, Max_pipeline_size, SSL_options, Process_options) -> any()

+
+ +

start_link/1

+
+

start_link(Args) -> any()

+
+ +

stop/1

+
+

stop(Lb_pid) -> any()

+
+ +

terminate/2

+
+

terminate(Reason, State) -> any()

+
+
+ +
Overviewerlang logo
+

Generated by EDoc, Nov 6 2015, 11:40:24.

+ + diff --git a/doc/ibrowse_socks5.html b/doc/ibrowse_socks5.html new file mode 100644 index 0000000..bddd420 --- /dev/null +++ b/doc/ibrowse_socks5.html @@ -0,0 +1,31 @@ + + + + +Module ibrowse_socks5 + + + +
Overviewerlang logo
+
+ +

Module ibrowse_socks5

+ + + +

Function Index

+ +
connect/5
+ +

Function Details

+ +

connect/5

+
+

connect(Host, Port, Options, SockOptions, Timeout) -> any()

+
+
+ +
Overviewerlang logo
+

Generated by EDoc, Nov 6 2015, 11:40:24.

+ + diff --git a/doc/ibrowse_sup.html b/doc/ibrowse_sup.html new file mode 100644 index 0000000..0e5226d --- /dev/null +++ b/doc/ibrowse_sup.html @@ -0,0 +1,38 @@ + + + + +Module ibrowse_sup + + + +
Overviewerlang logo
+
+ +

Module ibrowse_sup

+ + +

Behaviours: supervisor.

+ +

Function Index

+ + +
init/1
start_link/0
+ +

Function Details

+ +

init/1

+
+

init(X1) -> any()

+
+ +

start_link/0

+
+

start_link() -> any()

+
+
+ +
Overviewerlang logo
+

Generated by EDoc, Nov 6 2015, 11:40:24.

+ + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..657b98c --- /dev/null +++ b/doc/index.html @@ -0,0 +1,17 @@ + + + +The ibrowse application + + + + + + +<h2>This page uses frames</h2> +<p>Your browser does not accept frames. +<br>You should go to the <a href="overview-summary.html">non-frame version</a> instead. +</p> + + + \ No newline at end of file diff --git a/doc/modules-frame.html b/doc/modules-frame.html new file mode 100644 index 0000000..3d6f50c --- /dev/null +++ b/doc/modules-frame.html @@ -0,0 +1,18 @@ + + + +The ibrowse application + + + +

Modules

+ + + + + + + +
ibrowse
ibrowse_app
ibrowse_http_client
ibrowse_lb
ibrowse_lib
ibrowse_socks5
ibrowse_sup
+ + \ No newline at end of file diff --git a/doc/overview-summary.html b/doc/overview-summary.html new file mode 100644 index 0000000..b563096 --- /dev/null +++ b/doc/overview-summary.html @@ -0,0 +1,16 @@ + + + + +The ibrowse application + + + +
Overviewerlang logo
+

The ibrowse application

+ +
+
Overviewerlang logo
+

Generated by EDoc, Nov 6 2015, 11:40:24.

+ + diff --git a/doc/stylesheet.css b/doc/stylesheet.css new file mode 100644 index 0000000..ab170c0 --- /dev/null +++ b/doc/stylesheet.css @@ -0,0 +1,55 @@ +/* standard EDoc style sheet */ +body { + font-family: Verdana, Arial, Helvetica, sans-serif; + margin-left: .25in; + margin-right: .2in; + margin-top: 0.2in; + margin-bottom: 0.2in; + color: #000000; + background-color: #ffffff; +} +h1,h2 { + margin-left: -0.2in; +} +div.navbar { + background-color: #add8e6; + padding: 0.2em; +} +h2.indextitle { + padding: 0.4em; + background-color: #add8e6; +} +h3.function,h3.typedecl { + background-color: #add8e6; + padding-left: 1em; +} +div.spec { + margin-left: 2em; + background-color: #eeeeee; +} +a.module { + text-decoration:none +} +a.module:hover { + background-color: #eeeeee; +} +ul.definitions { + list-style-type: none; +} +ul.index { + list-style-type: none; + background-color: #eeeeee; +} + +/* + * Minor style tweaks + */ +ul { + list-style-type: square; +} +table { + border-collapse: collapse; +} +td { + padding: 3 +}