Skip to content
Newer
Older
100644 102 lines (51 sloc) 3 KB
27905da @benoitc ease the use in the console and improve doc
authored
1
2
3 #Module hackney_deps#
4 * [Function Index](#index)
5 * [Function Details](#functions)
6
7
8 <a name="index"></a>
9
10 ##Function Index##
11
12
13 <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#deps_on_path-0">deps_on_path/0</a></td><td>List of project dependencies on the path.</td></tr><tr><td valign="top"><a href="#ensure-0">ensure/0</a></td><td>Ensure that the ebin and include paths for dependencies of
14 this application are on the code path.</td></tr><tr><td valign="top"><a href="#ensure-1">ensure/1</a></td><td>Ensure that all ebin and include paths for dependencies
15 of the application for Module are on the code path.</td></tr><tr><td valign="top"><a href="#get_base_dir-0">get_base_dir/0</a></td><td>Return the application directory for this application.</td></tr><tr><td valign="top"><a href="#get_base_dir-1">get_base_dir/1</a></td><td>Return the application directory for Module.</td></tr><tr><td valign="top"><a href="#local_path-1">local_path/1</a></td><td>Return an application-relative directory for this application.</td></tr><tr><td valign="top"><a href="#local_path-2">local_path/2</a></td><td>Return an application-relative directory from Module's application.</td></tr><tr><td valign="top"><a href="#new_siblings-1">new_siblings/1</a></td><td>Find new siblings paths relative to Module that aren't already on the
16 code path.</td></tr></table>
17
18
19 <a name="functions"></a>
20
21 ##Function Details##
22
23 <a name="deps_on_path-0"></a>
24
25 ###deps_on_path/0##
26
27
28 <pre>deps_on_path() -&gt; [ProjNameAndVers]</pre>
29 <br></br>
30
31
32 List of project dependencies on the path.<a name="ensure-0"></a>
33
34 ###ensure/0##
35
36
37 <pre>ensure() -&gt; ok</pre>
38 <br></br>
39
40
41 Ensure that the ebin and include paths for dependencies of
42 this application are on the code path. Equivalent to
43 ensure(?Module).<a name="ensure-1"></a>
44
45 ###ensure/1##
46
47
48 <pre>ensure(Module) -&gt; ok</pre>
49 <br></br>
50
51
52 Ensure that all ebin and include paths for dependencies
53 of the application for Module are on the code path.<a name="get_base_dir-0"></a>
54
55 ###get_base_dir/0##
56
57
58 <pre>get_base_dir() -&gt; string()</pre>
59 <br></br>
60
61
62 Return the application directory for this application. Equivalent to
63 get_base_dir(?MODULE).<a name="get_base_dir-1"></a>
64
65 ###get_base_dir/1##
66
67
68 <pre>get_base_dir(Module) -&gt; string()</pre>
69 <br></br>
70
71
72 Return the application directory for Module. It assumes Module is in
73 a standard OTP layout application in the ebin or src directory.<a name="local_path-1"></a>
74
75 ###local_path/1##
76
77
78 <pre>local_path(Components) -&gt; string()</pre>
79 <br></br>
80
81
82 Return an application-relative directory for this application.
83 Equivalent to local_path(Components, ?MODULE).<a name="local_path-2"></a>
84
85 ###local_path/2##
86
87
88 <pre>local_path(Components::[string()], Module) -&gt; string()</pre>
89 <br></br>
90
91
92 Return an application-relative directory from Module's application.<a name="new_siblings-1"></a>
93
94 ###new_siblings/1##
95
96
97 <pre>new_siblings(Module) -&gt; [Dir]</pre>
98 <br></br>
99
100
101 Find new siblings paths relative to Module that aren't already on the
102 code path.
Something went wrong with that request. Please try again.