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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module edoc_lib</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css">
</head>
<body bgcolor="white">
<h1>Module edoc_lib</h1>
Utility functions for EDoc.
<p>Copyright 2001-2003 Richard Carlsson</p>
<ul><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<p><b>Authors:</b> Richard Carlsson (<a href="mailto:richardc@csd.uu.se"><tt>richardc@csd.uu.se</tt></a>).</p>
<p><b>See also:</b> <a href="edoc.html">edoc</a>.</p>
<h2><a name="description">Description</a></h2>Utility functions for EDoc.
<h2><a name="types">Data Types</a></h2>
<h3><a name="type-edoc_env">edoc_env()</a></h3>
<p><b>abstract datatype</b>: <tt>edoc_env()</tt></p>
<p>Environment information needed by EDoc for
generating references. The data representation is not documented.
</p>
<h3><a name="type-info">info()</a></h3>
<p><tt>info() = #info{name = string(), mail = string(), uri = string()}</tt></p>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1"><tr><td valign="top"><a href="#copy_dir-2">copy_dir/2</a></td><td/></tr>
<tr><td valign="top"><a href="#copy_file-2">copy_file/2</a></td><td/></tr>
<tr><td valign="top"><a href="#count-2">count/2</a></td><td/></tr>
<tr><td valign="top"><a href="#escape_uri-1">escape_uri/1</a></td><td/></tr>
<tr><td valign="top"><a href="#filename-1">filename/1</a></td><td/></tr>
<tr><td valign="top"><a href="#find_doc_dirs-0">find_doc_dirs/0</a></td><td/></tr>
<tr><td valign="top"><a href="#find_file-3">find_file/3</a></td><td/></tr>
<tr><td valign="top"><a href="#find_sources-2">find_sources/2</a></td><td/></tr>
<tr><td valign="top"><a href="#find_sources-3">find_sources/3</a></td><td>See <a href="edoc.html#run-3"><code>edoc:run/3</code></a> for a description of the options
<code>subpackages</code>, <code>source_suffix</code> and <code>exclude_packages</code>.</td></tr>
<tr><td valign="top"><a href="#get_doc_env-1">get_doc_env/1</a></td><td><p>Equivalent to <a href="#get_doc_env-4"><tt>get_doc_env([], [], [], Opts)</tt></a>.</p>
</td></tr>
<tr><td valign="top"><a href="#get_doc_env-4">get_doc_env/4</a></td><td>Creates an environment data structure used by parts of EDoc for
generating references, etc.</td></tr>
<tr><td valign="top"><a href="#get_first_sentence-1">get_first_sentence/1</a></td><td/></tr>
<tr><td valign="top"><a href="#is_name-1">is_name/1</a></td><td/></tr>
<tr><td valign="top"><a href="#is_relative_uri-1">is_relative_uri/1</a></td><td/></tr>
<tr><td valign="top"><a href="#is_space-1">is_space/1</a></td><td/></tr>
<tr><td valign="top"><a href="#join_uri-2">join_uri/2</a></td><td/></tr>
<tr><td valign="top"><a href="#lines-1">lines/1</a></td><td/></tr>
<tr><td valign="top"><a href="#parse_contact-2">parse_contact/2</a></td><td>EDoc "contact information" parsing.</td></tr>
<tr><td valign="top"><a href="#parse_expr-2">parse_expr/2</a></td><td>EDoc Erlang expression parsing.</td></tr>
<tr><td valign="top"><a href="#read_info_file-1">read_info_file/1</a></td><td/></tr>
<tr><td valign="top"><a href="#run_doclet-2">run_doclet/2</a></td><td>See <a href="edoc.html#run-3"><code>edoc:run/3</code></a> for a description of the <code>doclet</code> option.</td></tr>
<tr><td valign="top"><a href="#run_layout-2">run_layout/2</a></td><td>See <a href="edoc.html#layout-2"><code>edoc:layout/2</code></a> for a description of the <code>layout</code>
option.</td></tr>
<tr><td valign="top"><a href="#segment-2">segment/2</a></td><td/></tr>
<tr><td valign="top"><a href="#simplify_path-1">simplify_path/1</a></td><td/></tr>
<tr><td valign="top"><a href="#split_at-2">split_at/2</a></td><td/></tr>
<tr><td valign="top"><a href="#split_at_stop-1">split_at_stop/1</a></td><td/></tr>
<tr><td valign="top"><a href="#strip_space-1">strip_space/1</a></td><td/></tr>
<tr><td valign="top"><a href="#to_label-1">to_label/1</a></td><td/></tr>
<tr><td valign="top"><a href="#transpose-1">transpose/1</a></td><td/></tr>
<tr><td valign="top"><a href="#try_subdir-2">try_subdir/2</a></td><td/></tr>
<tr><td valign="top"><a href="#unique-1">unique/1</a></td><td/></tr>
<tr><td valign="top"><a href="#uri_get-1">uri_get/1</a></td><td/></tr>
<tr><td valign="top"><a href="#write_file-3">write_file/3</a></td><td>Write the given <code>Text</code> to the file named by <code>Name</code> in directory
<code>Dir</code>.</td></tr>
<tr><td valign="top"><a href="#write_file-4">write_file/4</a></td><td>Like <a href="#write_file-3"><code>write_file/3</code></a>, but adds path components to the target
directory corresponding to the specified package.</td></tr>
<tr><td valign="top"><a href="#write_info_file-4">write_info_file/4</a></td><td/></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3><a name="copy_dir-2">copy_dir/2</a></h3>
<tt>copy_dir(From, To) -> term()
</tt>
<h3><a name="copy_file-2">copy_file/2</a></h3>
<tt>copy_file(From, To) -> term()
</tt>
<h3><a name="count-2">count/2</a></h3>
<tt>count(X, Xs) -> term()
</tt>
<h3><a name="escape_uri-1">escape_uri/1</a></h3>
<tt>escape_uri(Cs) -> term()
</tt>
<h3><a name="filename-1">filename/1</a></h3>
<tt>filename(T) -> term()
</tt>
<h3><a name="find_doc_dirs-0">find_doc_dirs/0</a></h3>
<tt>find_doc_dirs() -> term()
</tt>
<h3><a name="find_file-3">find_file/3</a></h3>
<tt>find_file(Ps, Pkg, Name) -> term()
</tt>
<h3><a name="find_sources-2">find_sources/2</a></h3>
<tt>find_sources(Path, Opts) -> term()
</tt>
<h3><a name="find_sources-3">find_sources/3</a></h3>
<tt>find_sources(Path, Pkg, Opts) -> term()
</tt><p>See <a href="edoc.html#run-3"><code>edoc:run/3</code></a> for a description of the options
<code>subpackages</code>, <code>source_suffix</code> and <code>exclude_packages</code>.</p>
<h3><a name="get_doc_env-1">get_doc_env/1</a></h3>
<p><tt>get_doc_env(Options::<a href="edoc.html#type-option_list">edoc:option_list()</a>) -> <a href="#type-edoc_env">edoc_env()</a></tt></p>
<p>Equivalent to <a href="#get_doc_env-4"><tt>get_doc_env([], [], [], Opts)</tt></a>.</p>
<h3><a name="get_doc_env-4">get_doc_env/4</a></h3>
<p><tt>get_doc_env(App, Packages, Modules, Options::<a href="edoc.html#type-option_list">edoc:option_list()</a>) -> <a href="#type-edoc_env">edoc_env()</a></tt>
<ul><li><tt>App = [] | atom()</tt></li><li><tt>Packages = [atom()]</tt></li><li><tt>Modules = [atom()]</tt></li></ul></p>
<p>Creates an environment data structure used by parts of EDoc for
generating references, etc. See <a href="edoc.html#run-3"><code>edoc:run/3</code></a> for a description
of the options <code>file_suffix</code>, <code>app_default</code> and <code>doc_path</code>.
</p>
<p><b>See also:</b> <a href="edoc.html#get_doc-3">edoc:get_doc/3</a>, <a href="edoc_extract.html#source-4">edoc_extract:source/4</a>.</p>
<h3><a name="get_first_sentence-1">get_first_sentence/1</a></h3>
<tt>get_first_sentence(Es) -> term()
</tt>
<h3><a name="is_name-1">is_name/1</a></h3>
<tt>is_name(Cs) -> term()
</tt>
<h3><a name="is_relative_uri-1">is_relative_uri/1</a></h3>
<tt>is_relative_uri(Cs) -> term()
</tt>
<h3><a name="is_space-1">is_space/1</a></h3>
<tt>is_space(Cs) -> term()
</tt>
<h3><a name="join_uri-2">join_uri/2</a></h3>
<tt>join_uri(Base, Path) -> term()
</tt>
<h3><a name="lines-1">lines/1</a></h3>
<tt>lines(Cs) -> term()
</tt>
<h3><a name="parse_contact-2">parse_contact/2</a></h3>
<tt>parse_contact(S, L) -> term()
</tt><p>EDoc "contact information" parsing. This is the type of the
content in e.g.
<a href="overview-summary.html#mtag-author"><code>@author</code></a> tags.</p>
<h3><a name="parse_expr-2">parse_expr/2</a></h3>
<tt>parse_expr(S, L) -> term()
</tt><p>EDoc Erlang expression parsing. For parsing things like the
content of <a href="overview-summary.html#ftag-equiv"><code>@equiv</code></a>
tags, and strings denoting file names, e.g. in @headerfile. Also used
by <a href="edoc_run.html"><code>edoc_run</code></a>.</p>
<h3><a name="read_info_file-1">read_info_file/1</a></h3>
<tt>read_info_file(Dir) -> term()
</tt>
<h3><a name="run_doclet-2">run_doclet/2</a></h3>
<tt>run_doclet(Fun, Opts) -> term()
</tt><p>See <a href="edoc.html#run-3"><code>edoc:run/3</code></a> for a description of the <code>doclet</code> option.</p>
<h3><a name="run_layout-2">run_layout/2</a></h3>
<tt>run_layout(Fun, Opts) -> term()
</tt><p>See <a href="edoc.html#layout-2"><code>edoc:layout/2</code></a> for a description of the <code>layout</code>
option.</p>
<h3><a name="segment-2">segment/2</a></h3>
<tt>segment(Es, N) -> term()
</tt>
<h3><a name="simplify_path-1">simplify_path/1</a></h3>
<tt>simplify_path(P) -> term()
</tt>
<h3><a name="split_at-2">split_at/2</a></h3>
<tt>split_at(Cs, K) -> term()
</tt>
<h3><a name="split_at_stop-1">split_at_stop/1</a></h3>
<tt>split_at_stop(Cs) -> term()
</tt>
<h3><a name="strip_space-1">strip_space/1</a></h3>
<tt>strip_space(Cs) -> term()
</tt>
<h3><a name="to_label-1">to_label/1</a></h3>
<tt>to_label(Cs) -> term()
</tt>
<h3><a name="transpose-1">transpose/1</a></h3>
<tt>transpose(Xss) -> term()
</tt>
<h3><a name="try_subdir-2">try_subdir/2</a></h3>
<tt>try_subdir(Dir, Subdir) -> term()
</tt>
<h3><a name="unique-1">unique/1</a></h3>
<tt>unique(Xs) -> term()
</tt>
<h3><a name="uri_get-1">uri_get/1</a></h3>
<tt>uri_get(Path) -> term()
</tt>
<h3><a name="write_file-3">write_file/3</a></h3>
<p><tt>write_file(Text::deep_string(), Dir::<a href="edoc.html#type-filename">edoc:filename()</a>, Name::<a href="edoc.html#type-filename">edoc:filename()</a>) -> ok</tt></p>
<p>Write the given <code>Text</code> to the file named by <code>Name</code> in directory
<code>Dir</code>. If the target directory does not exist, it will be created.</p>
<h3><a name="write_file-4">write_file/4</a></h3>
<p><tt>write_file(Text::deep_string(), Dir::<a href="edoc.html#type-filename">edoc:filename()</a>, Name::<a href="edoc.html#type-filename">edoc:filename()</a>, Package::atom() | string()) -> ok</tt></p>
<p>Like <a href="#write_file-3"><code>write_file/3</code></a>, but adds path components to the target
directory corresponding to the specified package.</p>
<h3><a name="write_info_file-4">write_info_file/4</a></h3>
<tt>write_info_file(App, Packages, Modules, Dir) -> term()
</tt>
</body>
</html>
|
