Skip to content

Commit 6fa5e4a

Browse files
author
Kirill Platonov
committed
add doc
1 parent 1c85ec9 commit 6fa5e4a

20 files changed

+2845
-3
lines changed

‎.yardopts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
--private
22
--protected
3-
-o doc/ruby
3+
--readme README.md
4+
--charset utf-8

‎Gemfile.lock

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
proxy_manager (0.0.6)
4+
proxy_manager (0.0.7)
55
net-ping (~> 1.7, >= 1.7.2)
66

77
GEM

‎doc/ProxyManager.html

+357
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,357 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<title>
7+
Module: ProxyManager
8+
9+
&mdash; Documentation by YARD 0.8.7.4
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16+
17+
<script type="text/javascript" charset="utf-8">
18+
hasFrames = window.top.frames.main ? true : false;
19+
relpath = '';
20+
framesUrl = "frames.html#!ProxyManager.html";
21+
</script>
22+
23+
24+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25+
26+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27+
28+
29+
</head>
30+
<body>
31+
<div id="header">
32+
<div id="menu">
33+
34+
<a href="_index.html">Index (P)</a> &raquo;
35+
36+
37+
<span class="title">ProxyManager</span>
38+
39+
40+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41+
</div>
42+
43+
<div id="search">
44+
45+
<a class="full_list_link" id="class_list_link"
46+
href="class_list.html">
47+
Class List
48+
</a>
49+
50+
<a class="full_list_link" id="method_list_link"
51+
href="method_list.html">
52+
Method List
53+
</a>
54+
55+
<a class="full_list_link" id="file_list_link"
56+
href="file_list.html">
57+
File List
58+
</a>
59+
60+
</div>
61+
<div class="clear"></div>
62+
</div>
63+
64+
<iframe id="search_frame"></iframe>
65+
66+
<div id="content"><h1>Module: ProxyManager
67+
68+
69+
70+
</h1>
71+
72+
<dl class="box">
73+
74+
75+
76+
77+
78+
79+
80+
81+
<dt class="r1 last">Defined in:</dt>
82+
<dd class="r1 last">lib/proxy_manager.rb<span class="defines">,<br />
83+
lib/proxy_manager/main.rb</span>
84+
</dd>
85+
86+
</dl>
87+
<div class="clear"></div>
88+
89+
<h2>Defined Under Namespace</h2>
90+
<p class="children">
91+
92+
93+
94+
95+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ProxyManager/Main.html" title="ProxyManager::Main (class)">Main</a></span>
96+
97+
98+
</p>
99+
100+
101+
102+
103+
104+
105+
106+
107+
<h2>
108+
Class Method Summary
109+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
110+
</h2>
111+
112+
<ul class="summary">
113+
114+
<li class="public ">
115+
<span class="summary_signature">
116+
117+
<a href="#load-class_method" title="load (class method)">+ (Class) <strong>load</strong>(proxies, bad_proxies = nil) </a>
118+
119+
120+
121+
</span>
122+
123+
124+
125+
126+
127+
128+
129+
130+
131+
<span class="summary_desc"><div class='inline'>
132+
<p>Create main object.</p>
133+
</div></span>
134+
135+
</li>
136+
137+
138+
<li class="public ">
139+
<span class="summary_signature">
140+
141+
<a href="#root-class_method" title="root (class method)">+ (String) <strong>root</strong> </a>
142+
143+
144+
145+
</span>
146+
147+
148+
149+
150+
151+
152+
153+
154+
155+
<span class="summary_desc"><div class='inline'>
156+
<p>Define gem&#39;s root path.</p>
157+
</div></span>
158+
159+
</li>
160+
161+
162+
</ul>
163+
164+
165+
166+
167+
<div id="class_method_details" class="method_details_list">
168+
<h2>Class Method Details</h2>
169+
170+
171+
<div class="method_details first">
172+
<h3 class="signature first" id="load-class_method">
173+
174+
+ (<tt>Class</tt>) <strong>load</strong>(proxies, bad_proxies = nil)
175+
176+
177+
178+
179+
180+
</h3><div class="docstring">
181+
<div class="discussion">
182+
183+
<p>Create main object</p>
184+
185+
186+
</div>
187+
</div>
188+
<div class="tags">
189+
190+
<div class="examples">
191+
<p class="tag_title">Examples:</p>
192+
193+
194+
<pre class="example code"><code><span class='comment'># from array
195+
</span><span class='id identifier rubyid_proxy'>proxy</span> <span class='op'>=</span> <span class='const'>ProxyManager</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.2.3.4:567</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>9.8.7.6:543</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
196+
197+
<span class='comment'># or from file
198+
</span><span class='id identifier rubyid_proxy'>proxy</span> <span class='op'>=</span> <span class='const'>ProxyManager</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>proxies.txt</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>bad_proxies.txt</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
199+
200+
</div>
201+
<p class="tag_title">Parameters:</p>
202+
<ul class="param">
203+
204+
<li>
205+
206+
<span class='name'>proxies</span>
207+
208+
209+
<span class='type'>(<tt>Array</tt>, <tt>String</tt>)</span>
210+
211+
212+
213+
&mdash;
214+
<div class='inline'>
215+
<p>array of proxies or file with proxies</p>
216+
</div>
217+
218+
</li>
219+
220+
<li>
221+
222+
<span class='name'>bad_proxies</span>
223+
224+
225+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
226+
227+
228+
<em class="default">(defaults to: <tt>nil</tt>)</em>
229+
230+
231+
&mdash;
232+
<div class='inline'>
233+
<p>optional file for save bad proxies</p>
234+
</div>
235+
236+
</li>
237+
238+
</ul>
239+
240+
<p class="tag_title">Returns:</p>
241+
<ul class="return">
242+
243+
<li>
244+
245+
246+
<span class='type'>(<tt>Class</tt>)</span>
247+
248+
249+
250+
&mdash;
251+
<div class='inline'>
252+
<p>Main object</p>
253+
</div>
254+
255+
</li>
256+
257+
</ul>
258+
259+
<p class="tag_title">See Also:</p>
260+
<ul class="see">
261+
262+
<li><span class='object_link'><a href="ProxyManager/Main.html" title="ProxyManager::Main (class)">Main</a></span></li>
263+
264+
</ul>
265+
266+
</div><table class="source_code">
267+
<tr>
268+
<td>
269+
<pre class="lines">
270+
271+
272+
22
273+
23
274+
24</pre>
275+
</td>
276+
<td>
277+
<pre class="code"><span class="info file"># File 'lib/proxy_manager.rb', line 22</span>
278+
279+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_proxies'>proxies</span><span class='comma'>,</span> <span class='id identifier rubyid_bad_proxies'>bad_proxies</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
280+
<span class='const'>Main</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_proxies'>proxies</span><span class='comma'>,</span> <span class='id identifier rubyid_bad_proxies'>bad_proxies</span><span class='rparen'>)</span>
281+
<span class='kw'>end</span></pre>
282+
</td>
283+
</tr>
284+
</table>
285+
</div>
286+
287+
<div class="method_details ">
288+
<h3 class="signature " id="root-class_method">
289+
290+
+ (<tt>String</tt>) <strong>root</strong>
291+
292+
293+
294+
295+
296+
</h3><div class="docstring">
297+
<div class="discussion">
298+
299+
<p>Define gem&#39;s root path</p>
300+
301+
302+
</div>
303+
</div>
304+
<div class="tags">
305+
306+
<p class="tag_title">Returns:</p>
307+
<ul class="return">
308+
309+
<li>
310+
311+
312+
<span class='type'>(<tt>String</tt>)</span>
313+
314+
315+
316+
&mdash;
317+
<div class='inline'>
318+
<p>string path</p>
319+
</div>
320+
321+
</li>
322+
323+
</ul>
324+
325+
</div><table class="source_code">
326+
<tr>
327+
<td>
328+
<pre class="lines">
329+
330+
331+
7
332+
8
333+
9</pre>
334+
</td>
335+
<td>
336+
<pre class="code"><span class="info file"># File 'lib/proxy_manager.rb', line 7</span>
337+
338+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span>
339+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>../..</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>__FILE__</span>
340+
<span class='kw'>end</span></pre>
341+
</td>
342+
</tr>
343+
</table>
344+
</div>
345+
346+
</div>
347+
348+
</div>
349+
350+
<div id="footer">
351+
Generated on Mon Mar 31 19:20:19 2014 by
352+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
353+
0.8.7.4 (ruby-2.1.0).
354+
</div>
355+
356+
</body>
357+
</html>

0 commit comments

Comments
 (0)