Skip to content

Commit d9f385c

Browse files
committed
resolve all kdoc references
1 parent 4b5075f commit d9f385c

File tree

17 files changed

+43
-11
lines changed

17 files changed

+43
-11
lines changed

docs/docs/spotify-web-api-kotlin/alltypes/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ <h5><a href="../com.adamratzman.spotify.models/-audio-segment/index.html">com.ad
104104
<tr>
105105
(common, js, jvm)
106106
<h5><a href="../com.adamratzman.spotify.models/-authentication-error/index.html">com.adamratzman.spotify.models.AuthenticationError</a></h5>
107+
<p>An exception during the authentication process</p>
107108
</tr>
108109
<tr>
109110
(common, js, jvm)
@@ -250,7 +251,7 @@ <h5><a href="../com.adamratzman.spotify.models/-error-object/index.html">com.ada
250251
<tr>
251252
(common, js, jvm)
252253
<h5><a href="../com.adamratzman.spotify.models/-error-response/index.html">com.adamratzman.spotify.models.ErrorResponse</a></h5>
253-
<p>Wraps around <a href="../com.adamratzman.spotify.models/-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a></p>
254+
<p>Wraps around <a href="../com.adamratzman.spotify.models/-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a>. Serialized raw Spotify error response</p>
254255
</tr>
255256
<tr>
256257
(common, js, jvm)
@@ -443,6 +444,7 @@ <h5><a href="../com.adamratzman.spotify.models/-restrictions/index.html">com.ada
443444
<tr>
444445
(common, js, jvm)
445446
<h5><a href="../com.adamratzman.spotify.models/-result-enum/index.html">com.adamratzman.spotify.models.ResultEnum</a></h5>
447+
<p>Interface that allows easy identifier retrieval for children with an implemented identifier</p>
446448
</tr>
447449
<tr>
448450
(common, js, jvm)
@@ -627,6 +629,7 @@ <h5><a href="../com.adamratzman.spotify.models/-spotify-uri/index.html">com.adam
627629
<tr>
628630
(common, js, jvm)
629631
<h5><a href="../com.adamratzman.spotify.models/-spotify-uri-exception/index.html">com.adamratzman.spotify.models.SpotifyUriException</a></h5>
632+
<p>Exception instantiating or deserializing a uri perceived as invalid</p>
630633
</tr>
631634
<tr>
632635
(common, js, jvm)

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-authentication-error/-init-.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@
1010
<h1>&lt;init&gt;</h1>
1111
<a name="com.adamratzman.spotify.models.AuthenticationError$&lt;init&gt;(kotlin.String, kotlin.String)"></a>
1212
(common, js, jvm) <code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.AuthenticationError$<init>(kotlin.String, kotlin.String)/error">error</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.models.AuthenticationError$<init>(kotlin.String, kotlin.String)/description">description</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span></code>
13+
<p>An exception during the authentication process</p>
1314
</BODY>
1415
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-authentication-error/description.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,9 @@
1010
<h1>description</h1>
1111
<a name="com.adamratzman.spotify.models.AuthenticationError$description"></a>
1212
(common, js, jvm) <code><span class="keyword">val </span><span class="identifier">description</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
13+
<p>More detailed description of the error</p>
14+
<h3>Property</h3>
15+
<p><a name="description"></a>
16+
<code>description</code> - More detailed description of the error</p>
1317
</BODY>
1418
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-authentication-error/error.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,9 @@
1010
<h1>error</h1>
1111
<a name="com.adamratzman.spotify.models.AuthenticationError$error"></a>
1212
(common, js, jvm) <code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
13+
<p>Short error message</p>
14+
<h3>Property</h3>
15+
<p><a name="error"></a>
16+
<code>error</code> - Short error message</p>
1317
</BODY>
1418
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-authentication-error/index.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<h1>AuthenticationError</h1>
1111
<a name="com.adamratzman.spotify.models.AuthenticationError"></a>
1212
(common, js, jvm) <code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">AuthenticationError</span></code>
13+
<p>An exception during the authentication process</p>
1314
<h3>Constructors</h3>
1415
<table>
1516
<tbody>
@@ -19,6 +20,7 @@ <h3>Constructors</h3>
1920
<h4><a href="-init-.html">&lt;init&gt;</a></h4>
2021
</td>
2122
<td>
23+
<p>An exception during the authentication process</p>
2224
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.AuthenticationError$<init>(kotlin.String, kotlin.String)/error">error</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.models.AuthenticationError$<init>(kotlin.String, kotlin.String)/description">description</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span></code></td>
2325
</tr>
2426
</tbody>
@@ -32,6 +34,7 @@ <h3>Properties</h3>
3234
<h4><a href="description.html">description</a></h4>
3335
</td>
3436
<td>
37+
<p>More detailed description of the error</p>
3538
<code><span class="keyword">val </span><span class="identifier">description</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code></td>
3639
</tr>
3740
<tr>
@@ -40,6 +43,7 @@ <h4><a href="description.html">description</a></h4>
4043
<h4><a href="error.html">error</a></h4>
4144
</td>
4245
<td>
46+
<p>Short error message</p>
4347
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code></td>
4448
</tr>
4549
</tbody>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-error-response/-init-.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
<h1>&lt;init&gt;</h1>
1111
(common, js) <a name="com.adamratzman.spotify.models.ErrorResponse$&lt;init&gt;(com.adamratzman.spotify.models.ErrorObject, kotlin.Exception)"></a>
1212
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, kotlin.Exception)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../-error-object/index.html"><span class="identifier">ErrorObject</span></a><span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, kotlin.Exception)/exception">exception</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span class="identifier">Exception</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code>
13-
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a></p>
13+
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a>. Serialized raw Spotify error response</p>
1414
(jvm) <a name="com.adamratzman.spotify.models.ErrorResponse$&lt;init&gt;(com.adamratzman.spotify.models.ErrorObject, java.lang.Exception)"></a>
1515
<code><span class="identifier">ErrorResponse</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, java.lang.Exception)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../-error-object/index.html"><span class="identifier">ErrorObject</span></a><span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, java.lang.Exception)/exception">exception</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span class="identifier">Exception</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code>
16-
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a></p>
16+
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a>. Serialized raw Spotify error response</p>
1717
</BODY>
1818
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-error-response/error.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,9 @@
1010
<h1>error</h1>
1111
<a name="com.adamratzman.spotify.models.ErrorResponse$error"></a>
1212
(common, js, jvm) <code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="../-error-object/index.html"><span class="identifier">ErrorObject</span></a></code>
13+
<p>The error code and message, as returned by Spotify</p>
14+
<h3>Property</h3>
15+
<p><a name="error"></a>
16+
<code>error</code> - The error code and message, as returned by Spotify</p>
1317
</BODY>
1418
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-error-response/exception.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,9 @@
1010
<h1>exception</h1>
1111
<a name="com.adamratzman.spotify.models.ErrorResponse$exception"></a>
1212
(common, js, jvm) <code><span class="keyword">val </span><span class="identifier">exception</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span class="identifier">Exception</span></a><span class="symbol">?</span></code>
13+
<p>The associated Kotlin exception for this error</p>
14+
<h3>Property</h3>
15+
<p><a name="exception"></a>
16+
<code>exception</code> - The associated Kotlin exception for this error</p>
1317
</BODY>
1418
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-error-response/index.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<h1>ErrorResponse</h1>
1111
<a name="com.adamratzman.spotify.models.ErrorResponse"></a>
1212
(common, js, jvm) <code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ErrorResponse</span></code>
13-
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a></p>
13+
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a>. Serialized raw Spotify error response</p>
1414
<h3>Constructors</h3>
1515
<table>
1616
<tbody>
@@ -19,7 +19,7 @@ <h3>Constructors</h3>
1919
<h4><a href="-init-.html">&lt;init&gt;</a></h4>
2020
</td>
2121
<td>
22-
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a></p>
22+
<p>Wraps around <a href="../-error-object/index.html#com.adamratzman.spotify.models.ErrorObject">ErrorObject</a>. Serialized raw Spotify error response</p>
2323
(jvm) <code><span class="identifier">ErrorResponse</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, java.lang.Exception)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../-error-object/index.html"><span class="identifier">ErrorObject</span></a><span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, java.lang.Exception)/exception">exception</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span class="identifier">Exception</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code><br/>
2424
(common, js) <code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, kotlin.Exception)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../-error-object/index.html"><span class="identifier">ErrorObject</span></a><span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.models.ErrorResponse$<init>(com.adamratzman.spotify.models.ErrorObject, kotlin.Exception)/exception">exception</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span class="identifier">Exception</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code></td>
2525
</tr>
@@ -34,6 +34,7 @@ <h3>Properties</h3>
3434
<h4><a href="error.html">error</a></h4>
3535
</td>
3636
<td>
37+
<p>The error code and message, as returned by Spotify</p>
3738
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="../-error-object/index.html"><span class="identifier">ErrorObject</span></a></code></td>
3839
</tr>
3940
<tr>
@@ -42,6 +43,7 @@ <h4><a href="error.html">error</a></h4>
4243
<h4><a href="exception.html">exception</a></h4>
4344
</td>
4445
<td>
46+
<p>The associated Kotlin exception for this error</p>
4547
<code><span class="keyword">val </span><span class="identifier">exception</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span class="identifier">Exception</span></a><span class="symbol">?</span></code></td>
4648
</tr>
4749
</tbody>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-result-enum/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<h1>ResultEnum</h1>
1111
<a name="com.adamratzman.spotify.models.ResultEnum"></a>
1212
(common, js, jvm) <code><span class="keyword">interface </span><span class="identifier">ResultEnum</span></code>
13+
<p>Interface that allows easy identifier retrieval for children with an implemented identifier</p>
1314
<h3>Functions</h3>
1415
<table>
1516
<tbody>

0 commit comments

Comments
 (0)