Skip to content

Commit b78a006

Browse files
author
Travis CI User
committed
Automatic update of API docs / Clang Static Analysis
1 parent 6a3fc94 commit b78a006

File tree

921 files changed

+18109
-937
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

921 files changed

+18109
-937
lines changed

‎api/perl/Audio/XMMSClient.html‎

Lines changed: 1731 additions & 0 deletions
Large diffs are not rendered by default.

‎api/perl/Audio/XMMSClient/Collection.html‎

Lines changed: 450 additions & 0 deletions
Large diffs are not rendered by default.

‎api/perl/Audio/XMMSClient/Playlist.html‎

Lines changed: 526 additions & 0 deletions
Large diffs are not rendered by default.

‎api/perl/Audio/XMMSClient/Result.html‎

Lines changed: 248 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
<html><head><title>Audio::XMMSClient::Result</title>
2+
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
3+
<link rel="stylesheet" title="blkbluw" type="text/css" href="../../_blkbluw.css" media="all" >
4+
<link rel="alternate stylesheet" title="blkmagw" type="text/css" href="../../_blkmagw.css" media="all" >
5+
<link rel="alternate stylesheet" title="blkcynw" type="text/css" href="../../_blkcynw.css" media="all" >
6+
<link rel="alternate stylesheet" title="whtprpk" type="text/css" href="../../_whtprpk.css" media="all" >
7+
<link rel="alternate stylesheet" title="whtnavk" type="text/css" href="../../_whtnavk.css" media="all" >
8+
<link rel="alternate stylesheet" title="grygrnk" type="text/css" href="../../_grygrnk.css" media="all" >
9+
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../../_whtgrng.css" media="all" >
10+
<link rel="alternate stylesheet" title="blkgrng" type="text/css" href="../../_blkgrng.css" media="all" >
11+
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../../_grygrnw.css" media="all" >
12+
<link rel="alternate stylesheet" title="blkbluw" type="text/css" href="../../_blkbluw.css" media="all" >
13+
<link rel="alternate stylesheet" title="whtpurk" type="text/css" href="../../_whtpurk.css" media="all" >
14+
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../../_whtgrng.css" media="all" >
15+
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../../_grygrnw.css" media="all" >
16+
17+
<script type="text/javascript" src="../../_podly.js"></script>
18+
19+
</head>
20+
<body class='pod'>
21+
22+
23+
24+
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents">&lt;&lt;</a></b></p>
25+
26+
<div class='indexgroup'>
27+
<ul class='indexList indexList1'>
28+
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
29+
<li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
30+
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
31+
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
32+
<ul class='indexList indexList2'>
33+
<li class='indexItem indexItem2'><a href='#get_class'>get_class</a>
34+
<li class='indexItem indexItem2'><a href='#notifier_set'>notifier_set</a>
35+
<li class='indexItem indexItem2'><a href='#wait'>wait</a>
36+
<li class='indexItem indexItem2'><a href='#get_type'>get_type</a>
37+
<li class='indexItem indexItem2'><a href='#iserror'>iserror</a>
38+
<li class='indexItem indexItem2'><a href='#get_error'>get_error</a>
39+
<li class='indexItem indexItem2'><a href='#value'>value</a>
40+
<li class='indexItem indexItem2'><a href='#decode_url'>decode_url</a>
41+
</ul>
42+
<li class='indexItem indexItem1'><a href='#AUTHOR'>AUTHOR</a>
43+
<li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
44+
<li class='indexItem indexItem1'><a href='#COPYRIGHT_AND_LICENSE'>COPYRIGHT AND LICENSE</a>
45+
</ul>
46+
</div>
47+
48+
<h1><a class='u' href='#___top' title='click to go to top of document'
49+
name="NAME"
50+
>NAME</a></h1>
51+
52+
<p>Audio::XMMSClient::Result - Results of Audio::XMMSClient operations</p>
53+
54+
<h1><a class='u' href='#___top' title='click to go to top of document'
55+
name="SYNOPSIS"
56+
>SYNOPSIS</a></h1>
57+
58+
<pre> use Audio::XMMSClient;
59+
60+
my $conn = Audio::XMMSClient-&#62;new($client_name);
61+
$conn-&#62;connect or die $c-&#62;get_last_error;
62+
63+
my $result = $c-&#62;playback_status;
64+
$result-&#62;wait;
65+
print $result-&#62;value;</pre>
66+
67+
<h1><a class='u' href='#___top' title='click to go to top of document'
68+
name="DESCRIPTION"
69+
>DESCRIPTION</a></h1>
70+
71+
<p>This module provides an abstract, asyncronous interface to for retrieving results of <code>Audio::XMMSClient</code> server operations.</p>
72+
73+
<h1><a class='u' href='#___top' title='click to go to top of document'
74+
name="METHODS"
75+
>METHODS</a></h1>
76+
77+
<h2><a class='u' href='#___top' title='click to go to top of document'
78+
name="get_class"
79+
>get_class</a></h2>
80+
81+
<dl>
82+
<dt><a name="Arguments:_none"
83+
>Arguments: none</a></dt>
84+
85+
<dd>
86+
<dt><a name="Return_Value:_$class"
87+
>Return Value: $class</a></dt>
88+
</dl>
89+
90+
<pre> my $class = $result-&#62;get_class;</pre>
91+
92+
<p>Get the class of the result. This may be one of &#34;default&#34;, &#34;signal&#34; and &#34;broadcast&#34;.</p>
93+
94+
<h2><a class='u' href='#___top' title='click to go to top of document'
95+
name="notifier_set"
96+
>notifier_set</a></h2>
97+
98+
<dl>
99+
<dt><a name="Arguments:_\&#38;func,_$data?"
100+
>Arguments: \&#38;func, $data?</a></dt>
101+
102+
<dd>
103+
<dt><a name="Return_Value:_none"
104+
>Return Value: none</a></dt>
105+
</dl>
106+
107+
<pre> $result-&#62;notifier_set(sub { die &#39;got an answer!&#39; });</pre>
108+
109+
<p>Set up a callback for the result retrival. This callback will be called when the answers arrives. It&#39;s arguments will be the result itself as well as an optional userdata if <code>$data</code> is passed.</p>
110+
111+
<h2><a class='u' href='#___top' title='click to go to top of document'
112+
name="wait"
113+
>wait</a></h2>
114+
115+
<dl>
116+
<dt><a name="Arguments:_none"
117+
>Arguments: none</a></dt>
118+
119+
<dd>
120+
<dt><a name="Return_Value:_$result"
121+
>Return Value: $result</a></dt>
122+
</dl>
123+
124+
<pre> my $value = $result-&#62;wait-&#62;value;</pre>
125+
126+
<p>Block for the reply. In a synchronous application this can be used to wait for the result. Will return the <code>$result</code> this method was called when the server replyed.</p>
127+
128+
<h2><a class='u' href='#___top' title='click to go to top of document'
129+
name="get_type"
130+
>get_type</a></h2>
131+
132+
<dl>
133+
<dt><a name="Arguments:_none"
134+
>Arguments: none</a></dt>
135+
136+
<dd>
137+
<dt><a name="Return_Value:_$type"
138+
>Return Value: $type</a></dt>
139+
</dl>
140+
141+
<pre> my $type = $result-&#62;get_type;</pre>
142+
143+
<p>Get the type of the result. May be one of &#34;none&#34;, &#34;error&#34;, &#34;uint&#34;, &#34;int&#34;, &#34;string&#34;, &#34;dict&#34;, &#34;bin&#34;, &#34;coll&#34; or &#34;list&#34;.</p>
144+
145+
<h2><a class='u' href='#___top' title='click to go to top of document'
146+
name="iserror"
147+
>iserror</a></h2>
148+
149+
<dl>
150+
<dt><a name="Arguments:_none"
151+
>Arguments: none</a></dt>
152+
153+
<dd>
154+
<dt><a name="Return_Value:_1_|_0"
155+
>Return Value: 1 | 0</a></dt>
156+
</dl>
157+
158+
<pre> my $has_error = $result-&#62;iserror;</pre>
159+
160+
<p>Check if the result represents an error. Returns a true value if the result is an error, false otherwise.</p>
161+
162+
<h2><a class='u' href='#___top' title='click to go to top of document'
163+
name="get_error"
164+
>get_error</a></h2>
165+
166+
<dl>
167+
<dt><a name="Arguments:_none"
168+
>Arguments: none</a></dt>
169+
170+
<dd>
171+
<dt><a name="Return_Value:_$message"
172+
>Return Value: $message</a></dt>
173+
</dl>
174+
175+
<pre> my $message = $result-&#62;get_error;</pre>
176+
177+
<p>Get an error <code>$message</code> describing the error that occoured.</p>
178+
179+
<h2><a class='u' href='#___top' title='click to go to top of document'
180+
name="value"
181+
>value</a></h2>
182+
183+
<dl>
184+
<dt><a name="Arguments:_none"
185+
>Arguments: none</a></dt>
186+
187+
<dd>
188+
<dt><a name="Return_Value:_$scalar_|_\@arrayref_|_\%hashref_|_\%propdict"
189+
>Return Value: $scalar | \@arrayref | \%hashref | \%propdict</a></dt>
190+
</dl>
191+
192+
<pre> my $value = $result-&#62;value;</pre>
193+
194+
<p>Gets the return value of the <code>$result</code>. Depending of the results type (<a href="#get_type" class="podlinkpod"
195+
>&#34;get_type&#34;</a>) you might get other types of return values.</p>
196+
197+
<h2><a class='u' href='#___top' title='click to go to top of document'
198+
name="decode_url"
199+
>decode_url</a></h2>
200+
201+
<dl>
202+
<dt><a name="Arguments:_$string"
203+
>Arguments: $string</a></dt>
204+
205+
<dd>
206+
<dt><a name="Return_Value:_$decoded_url"
207+
>Return Value: $decoded_url</a></dt>
208+
</dl>
209+
210+
<pre> my $decoded_url = $result-&#62;decode_url($url);
211+
my $decoded_url = Audio::XMMSClient::Result-&#62;decode_url($url);</pre>
212+
213+
<p>Decode an URL-encoded <code>$string</code>.</p>
214+
215+
<p>Some strings (currently only the url of media) has no known encoding, and must be encoded in an UTF-8 clean way. This is done similar to the url encoding web browsers do. This functions decodes a string encoded in that way. OBSERVE that the decoded string HAS NO KNOWN ENCODING and you cannot display it on screen in a 100% guaranteed correct way (a good heuristic is to try to validate the decoded string as UTF-8, and if it validates assume that it is an UTF-8 encoded string, and otherwise fall back to some other encoding).</p>
216+
217+
<p>Do not use this function if you don&#39;t understand the implications. The best thing is not to try to display the url at all.</p>
218+
219+
<p>Note that the fact that the string has NO KNOWN ENCODING and CAN NOT BE DISPLAYED does not stop you from open the file if it is a local file (if it starts with &#34;file://&#34;).</p>
220+
221+
<p>This method can either be called as a class or instance method.</p>
222+
223+
<h1><a class='u' href='#___top' title='click to go to top of document'
224+
name="AUTHOR"
225+
>AUTHOR</a></h1>
226+
227+
<p>Florian Ragwitz &#60;rafl@debian.org&#62;</p>
228+
229+
<h1><a class='u' href='#___top' title='click to go to top of document'
230+
name="SEE_ALSO"
231+
>SEE ALSO</a></h1>
232+
233+
<p><a href="../../Audio/XMMSClient.html" class="podlinkpod"
234+
>Audio::XMMSClient</a>, <a href="../../Audio/XMMSClient/Result/PropDict.html" class="podlinkpod"
235+
>Audio::XMMSClient::Result::PropDict</a></p>
236+
237+
<h1><a class='u' href='#___top' title='click to go to top of document'
238+
name="COPYRIGHT_AND_LICENSE"
239+
>COPYRIGHT AND LICENSE</a></h1>
240+
241+
<p>Copyright (C) 2006-2008, Florian Ragwitz</p>
242+
243+
<p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.</p>
244+
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents">&lt;&lt;</a></b></p>
245+
246+
247+
248+
</body></html>

‎api/perl/_blkbluw.css‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/* This file is autogenerated. Do not edit. blkbluw */
2+
3+
@import url("./_blkbluw.css");
4+
.indexgroup { display: none; }
5+

‎api/perl/_blkcynw.css‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
/* This file is autogenerated. Do not edit. 100n=blkcynw */
2+
3+
/* For accessibility reasons, never specify text sizes in px/pt/pc/in/cm/mm */
4+
5+
@media all { .hide { display: none; } }
6+
7+
@media print {
8+
.noprint, div.indexgroup, .backlinktop, .backlinkbottom { display: none }
9+
10+
* {
11+
border-color: black !important;
12+
color: black !important;
13+
background-color: transparent !important;
14+
background-image: none !important;
15+
}
16+
17+
dl.superindex > dd {
18+
word-spacing: .6em;
19+
}
20+
}
21+
22+
@media aural, braille, embossed {
23+
div.indexgroup { display: none; } /* Too noisy, don't you think? */
24+
dl.superindex > dt:before { content: "Group "; }
25+
dl.superindex > dt:after { content: " contains:"; }
26+
.backlinktop a:before { content: "Back to contents"; }
27+
.backlinkbottom a:before { content: "Back to contents"; }
28+
}
29+
30+
@media aural {
31+
dl.superindex > dt { pause-before: 600ms; }
32+
}
33+
34+
@media screen, tty, tv, projection {
35+
.noscreen { display: none; }
36+
37+
a:link { color: #7070ff; text-decoration: underline; }
38+
a:visited { color: #e030ff; text-decoration: underline; }
39+
a:active { color: #800000; text-decoration: underline; }
40+
body.contentspage a { text-decoration: none; }
41+
a.u { color: #000 !important; text-decoration: none; }
42+
43+
body.pod {
44+
margin: 0 5px;
45+
color: #000;
46+
background-color: #fff;
47+
}
48+
49+
body.pod h1, body.pod h2, body.pod h3, body.pod h4 {
50+
font-family: Tahoma, Verdana, Helvetica, Arial, sans-serif;
51+
font-weight: normal;
52+
margin-top: 1.2em;
53+
margin-bottom: .1em;
54+
border-top: medium solid transparent;
55+
/* margin-left: -5px; border-left: 2px #7070ff solid; padding-left: 3px; */
56+
}
57+
58+
body.pod h1 { border-top-color: #5ff; }
59+
body.pod h2 { border-top-color: #7ff; }
60+
body.pod h3 { border-top-color: #bff; }
61+
body.pod h4 { border-top-color: #eff; }
62+
63+
p.backlinktop + h1 { border-top: none; margin-top: 0em; }
64+
p.backlinktop + h2 { border-top: none; margin-top: 0em; }
65+
p.backlinktop + h3 { border-top: none; margin-top: 0em; }
66+
p.backlinktop + h4 { border-top: none; margin-top: 0em; }
67+
68+
body.pod dt {
69+
font-size: 105%; /* just a wee bit more than normal */
70+
}
71+
72+
.indexgroup { font-size: 80%; }
73+
74+
.backlinktop, .backlinkbottom {
75+
margin-left: -5px;
76+
margin-right: -5px;
77+
background-color: #bff;
78+
border-top: medium solid #aff;
79+
border-bottom: medium solid #aff;
80+
}
81+
82+
.backlinktop a, .backlinkbottom a {
83+
text-decoration: none;
84+
color: #7ff;
85+
background-color: #fff;
86+
border: medium solid #2ff;
87+
}
88+
.backlinkbottom { margin-bottom: 0; padding-bottom: 0; }
89+
.backlinktop { margin-top: 0; padding-top: 0; }
90+
91+
body.contentspage {
92+
color: #000;
93+
background-color: #fff;
94+
}
95+
96+
body.contentspage h1 {
97+
color: #2ff;
98+
margin-left: 1em;
99+
margin-right: 1em;
100+
text-indent: -.9em;
101+
font-family: Tahoma, Verdana, Helvetica, Arial, sans-serif;
102+
font-weight: normal;
103+
border-top: medium solid #000;
104+
border-bottom: medium solid #000;
105+
text-align: center;
106+
}
107+
108+
dl.superindex > dt {
109+
font-family: Tahoma, Verdana, Helvetica, Arial, sans-serif;
110+
font-weight: normal;
111+
font-size: 90%;
112+
margin-top: .45em;
113+
/* margin-bottom: -.15em; */
114+
}
115+
dl.superindex > dd {
116+
word-spacing: .6em; /* most important rule here! */
117+
}
118+
dl.superindex > a:link {
119+
text-decoration: none;
120+
color: #000;
121+
}
122+
123+
.contentsfooty {
124+
border-top: medium solid #666;
125+
font-size: 90%;
126+
}
127+
128+
}
129+
130+
/* The End */
131+

0 commit comments

Comments
 (0)