forked from benoitc/couchbeam
/
couchbeam_deps.html
83 lines (70 loc) · 4.56 KB
/
couchbeam_deps.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module couchbeam_deps</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module couchbeam_deps</h1>
<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h2><a name="index">Function Index</a></h2>
<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
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
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
code path.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="deps_on_path-0">deps_on_path/0</a></h3>
<div class="spec">
<p><tt>deps_on_path() -> [ProjNameAndVers]</tt><br></p>
</div><p>List of project dependencies on the path.</p>
<h3 class="function"><a name="ensure-0">ensure/0</a></h3>
<div class="spec">
<p><tt>ensure() -> ok</tt><br></p>
</div><p>Ensure that the ebin and include paths for dependencies of
this application are on the code path. Equivalent to
ensure(?Module).</p>
<h3 class="function"><a name="ensure-1">ensure/1</a></h3>
<div class="spec">
<p><tt>ensure(Module) -> ok</tt><br></p>
</div><p>Ensure that all ebin and include paths for dependencies
of the application for Module are on the code path.</p>
<h3 class="function"><a name="get_base_dir-0">get_base_dir/0</a></h3>
<div class="spec">
<p><tt>get_base_dir() -> string()</tt><br></p>
</div><p>Return the application directory for this application. Equivalent to
get_base_dir(?MODULE).</p>
<h3 class="function"><a name="get_base_dir-1">get_base_dir/1</a></h3>
<div class="spec">
<p><tt>get_base_dir(Module) -> string()</tt><br></p>
</div><p>Return the application directory for Module. It assumes Module is in
a standard OTP layout application in the ebin or src directory.</p>
<h3 class="function"><a name="local_path-1">local_path/1</a></h3>
<div class="spec">
<p><tt>local_path(Components) -> string()</tt><br></p>
</div><p>Return an application-relative directory for this application.
Equivalent to local_path(Components, ?MODULE).</p>
<h3 class="function"><a name="local_path-2">local_path/2</a></h3>
<div class="spec">
<p><tt>local_path(Components::[string()], Module) -> string()</tt><br></p>
</div><p>Return an application-relative directory from Module's application.</p>
<h3 class="function"><a name="new_siblings-1">new_siblings/1</a></h3>
<div class="spec">
<p><tt>new_siblings(Module) -> [Dir]</tt><br></p>
</div><p>Find new siblings paths relative to Module that aren't already on the
code path.</p>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jan 3 2012, 15:42:58.</i></p>
</body>
</html>