fix unresolved properties in docs, expose SimpleEpisode.name

Signed-off-by: Adam Ratzman <[email protected]>

Author: adamint

README.md

@@ -37,7 +37,7 @@ repositories {
     jcenter()
 }
 
-implementation("com.adamratzman:spotify-api-kotlin-core:3.4.0")
+implementation("com.adamratzman:spotify-api-kotlin-core:3.4.01")
 ```
 
 Note that images and profiles are not supported on the Kotlin/JS target.

build.gradle.kts

@@ -32,7 +32,7 @@ buildscript {
 }
 
 group = "com.adamratzman"
-version = "3.4.0"
+version = "3.4.01"
 
 tasks.withType<Test> {
     this.testLogging {

src/commonMain/kotlin/com.adamratzman.spotify/Builder.kt

@@ -500,8 +500,8 @@ public enum class AuthorizationType {
 /**
  * Spotify Api builder interface
  *
- * @property T The type of [SpotifyApi] to be built
- * @property B The associated Api builder for [T]
+ * @param T The type of [SpotifyApi] to be built
+ * @param B The associated Api builder for [T]
  */
 public interface ISpotifyApiBuilder<T : SpotifyApi<T, B>, B : ISpotifyApiBuilder<T, B>> {
     /**
@@ -811,14 +811,14 @@ public class SpotifyCredentials {
 /**
  * User-defined authorization parameters
  *
- * @property authorizationCode Only available when building [SpotifyClientApi]. Spotify auth code
- * @property token Build the API using an existing token. If you're building [SpotifyClientApi], this
+ * @param authorizationCode Only available when building [SpotifyClientApi]. Spotify auth code
+ * @param token Build the API using an existing token. If you're building [SpotifyClientApi], this
  * will be your **access** token. If you're building [SpotifyApi], it will be your **refresh** token
- * @property tokenString Build the API using an existing token (string). If you're building [SpotifyClientApi], this
+ * @param tokenString Build the API using an existing token (string). If you're building [SpotifyClientApi], this
  * will be your **access** token. If you're building [SpotifyApi], it will be your **refresh** token. There is a *very*
  * limited time constraint on these before the API automatically refreshes them
- * @property refreshTokenString Refresh token, given as a string, to be exchanged to Spotify for a new token
- * @property pkceCodeVerifier The code verifier generated that the client authenticated with (using its code challenge)
+ * @param refreshTokenString Refresh token, given as a string, to be exchanged to Spotify for a new token
+ * @param pkceCodeVerifier The code verifier generated that the client authenticated with (using its code challenge)
  */
 public class SpotifyUserAuthorization(
     public var authorizationCode: String? = null,

src/commonMain/kotlin/com.adamratzman.spotify/SpotifyApi.kt

@@ -43,17 +43,16 @@ import kotlinx.serialization.json.Json
  * functionality and information between the [SpotifyClientApi] and [SpotifyAppApi]
  * implementations of the API
  *
- * @property clientId The application client id found on the application [dashboard](https://developer.spotify.com/dashboard/applications)
- * @property clientSecret The application client secret found on the application [dashboard](https://developer.spotify.com/dashboard/applications)
- * @property token The access token associated with this API instance
+ * @param clientId The application client id found on the application [dashboard](https://developer.spotify.com/dashboard/applications)
+ * @param clientSecret The application client secret found on the application [dashboard](https://developer.spotify.com/dashboard/applications)
+ * @param token The access token associated with this API instance
+ * @param spotifyApiOptions Configurable Spotify API options.
  *
  * @property search Provides access to the Spotify [search endpoint](https://developer.spotify.com/documentation/web-api/reference/search/search/)
  * @property albums Provides access to Spotify [album endpoints](https://developer.spotify.com/documentation/web-api/reference/albums/)
  * @property browse Provides access to Spotify [browse endpoints](https://developer.spotify.com/documentation/web-api/reference/browse/)
  * @property artists Provides access to Spotify [artist endpoints](https://developer.spotify.com/documentation/web-api/reference/artists/)
  * @property tracks Provides access to Spotify [track endpoints](https://developer.spotify.com/documentation/web-api/reference/tracks/)
- *
- * @property spotifyApiOptions Configurable Spotify API options.
  */
 public sealed class SpotifyApi<T : SpotifyApi<T, B>, B : ISpotifyApiBuilder<T, B>>(
     public val clientId: String?,

src/commonMain/kotlin/com.adamratzman.spotify/models/Albums.kt

@@ -9,25 +9,26 @@ import kotlinx.serialization.Serializable
 /**
  * Simplified Album object that can be used to retrieve a full [Album]
  *
- * @property href A link to the Web API endpoint providing full details of the album.
- * @property id The Spotify ID for the album.
- * @property albumGroup Optional. The field is present when getting an artist’s albums. Possible values
+ * @param href A link to the Web API endpoint providing full details of the album.
+ * @param id The Spotify ID for the album.
  * are “album”, “single”, “compilation”, “appears_on”. Compare to album_type this field represents relationship
  * between the artist and the album.
- * @property artists The artists of the album. Each artist object includes a link in href to more detailed information about the artist.
- * @property availableMarkets The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note
+ * @param artists The artists of the album. Each artist object includes a link in href to more detailed information about the artist.
  * that an album is considered available in a market when at least 1 of its tracks is available in that market.
- * @property images The cover art for the album in various sizes, widest first.
- * @property name The name of the album. In case of an album takedown, the value may be an empty string.
- * @property type The object type: “album”
- * @property releaseDate The date the album was first released, for example 1981. Depending on the precision,
+ * @param images The cover art for the album in various sizes, widest first.
+ * @param name The name of the album. In case of an album takedown, the value may be an empty string.
+ * @param type The object type: “album”
  * it might be shown as 1981-12 or 1981-12-15.
- * @property releaseDatePrecisionString The precision with which release_date value is known: year , month , or day.
- * @property albumType The type of the album: one of “album”, “single”, or “compilation”.
- * @property restrictions Part of the response when Track Relinking is applied, the original track is not available
+ * @param releaseDatePrecisionString The precision with which release_date value is known: year , month , or day.
+ * @param restrictions Part of the response when Track Relinking is applied, the original track is not available
  * in the given market, and Spotify did not have any tracks to relink it with. The track response will still contain
  * metadata for the original track, and a restrictions object containing the reason why the track is not available:
  * "restrictions" : {"reason" : "market"}
+ *
+ * @property albumGroup Optional. The field is present when getting an artist’s albums. Possible values
+ * @property availableMarkets The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note
+ * @property releaseDate The date the album was first released, for example 1981. Depending on the precision,
+ * @property albumType The type of the album: one of “album”, “single”, or “compilation”.
  */
 @Serializable
 public data class SimpleAlbum(
@@ -87,33 +88,34 @@ public enum class AlbumResultType(public val id: String) {
 /**
  * Represents an Album on Spotify
  *
- * @property albumType The type of the album: one of "album" , "single" , or "compilation".
- * @property artists The artists of the album. Each artist object includes a link in href to more detailed
+ * @param artists The artists of the album. Each artist object includes a link in href to more detailed
  * information about the artist.
- * @property availableMarkets The markets in which the album is available:
  * ISO 3166-1 alpha-2 country codes. Note that an album is considered
  * available in a market when at least 1 of its tracks is available in that market.
- * @property copyrights The copyright statements of the album.
- * @property externalIds Known external IDs for the album.
- * @property genres A list of the genres used to classify the album. For example: "Prog Rock" ,
+ * @param copyrights The copyright statements of the album.
+ * @param genres A list of the genres used to classify the album. For example: "Prog Rock" ,
  * "Post-Grunge". (If not yet classified, the array is empty.)
- * @property href A link to the Web API endpoint providing full details of the album.
- * @property id The Spotify ID for the album.
- * @property images The cover art for the album in various sizes, widest first.
- * @property label The label for the album.
- * @property name The name of the album. In case of an album takedown, the value may be an empty string.
- * @property popularity The popularity of the album. The value will be between 0 and 100, with 100 being the most
+ * @param href A link to the Web API endpoint providing full details of the album.
+ * @param id The Spotify ID for the album.
+ * @param images The cover art for the album in various sizes, widest first.
+ * @param label The label for the album.
+ * @param name The name of the album. In case of an album takedown, the value may be an empty string.
+ * @param popularity The popularity of the album. The value will be between 0 and 100, with 100 being the most
  * popular. The popularity is calculated from the popularity of the album’s individual tracks.
- * @property releaseDate The date the album was first released, for example 1981. Depending on the precision,
  * it might be shown as 1981-12 or 1981-12-15.
- * @property releaseDatePrecision The precision with which release_date value is known: year , month , or day.
- * @property tracks The tracks of the album.
- * @property type The object type: “album”
- * @property totalTracks the total amount of tracks in this album
- * @property restrictions Part of the response when Track Relinking is applied, the original track is not available
+ * @param releaseDatePrecision The precision with which release_date value is known: year , month , or day.
+ * @param tracks The tracks of the album.
+ * @param type The object type: “album”
+ * @param totalTracks the total amount of tracks in this album
+ * @param restrictions Part of the response when Track Relinking is applied, the original track is not available
  * in the given market, and Spotify did not have any tracks to relink it with.
  * The track response will still contain metadata for the original track, and a
  * restrictions object containing the reason why the track is not available: "restrictions" : {"reason" : "market"}
+ *
+ * @property releaseDate The date the album was first released, for example 1981. Depending on the precision,
+ * @property externalIds Known external IDs for the album.
+ * @property availableMarkets The markets in which the album is available:
+ * @property albumType The type of the album: one of "album" , "single" , or "compilation".
  */
 @Serializable
 public data class Album(
@@ -152,8 +154,7 @@ public data class Album(
  * Describes an album's copyright information
  *
  * @property text The copyright text for this album.
- * @property type The type of copyright: C = the copyright,
- * P = the sound recording (performance) copyright.
+ * @property type The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
  */
 @Serializable
 public data class SpotifyCopyright(

src/commonMain/kotlin/com.adamratzman.spotify/models/Artists.kt

@@ -7,10 +7,10 @@ import kotlinx.serialization.Serializable
 /**
  * Simplified Artist object that can be used to retrieve a full [Artist]
  *
- * @property href A link to the Web API endpoint providing full details of the artist.
- * @property id The Spotify ID for the artist.
- * @property name The name of the artist
- * @property type The object type: "artist"
+ * @param href A link to the Web API endpoint providing full details of the artist.
+ * @param id The Spotify ID for the artist.
+ * @param name The name of the artist
+ * @param type The object type: "artist"
  */
 @Serializable
 public data class SimpleArtist(
@@ -31,16 +31,16 @@ public data class SimpleArtist(
 /**
  * Represents an Artist (distinct from a regular user) on Spotify
  *
- * @property followers Information about the followers of the artist.
- * @property genres A list of the genres the artist is associated with. For example: "Prog Rock" ,
+ * @param followers Information about the followers of the artist.
+ * @param genres A list of the genres the artist is associated with. For example: "Prog Rock" ,
  * "Post-Grunge". (If not yet classified, the array is empty.)
- * @property href A link to the Web API endpoint providing full details of the artist.
- * @property id The Spotify ID for the artist.
- * @property images Images of the artist in various sizes, widest first.
- * @property name The name of the artist
- * @property popularity The popularity of the artist. The value will be between 0 and 100, with 100 being the most
+ * @param href A link to the Web API endpoint providing full details of the artist.
+ * @param id The Spotify ID for the artist.
+ * @param images Images of the artist in various sizes, widest first.
+ * @param name The name of the artist
+ * @param popularity The popularity of the artist. The value will be between 0 and 100, with 100 being the most
  * popular. The artist’s popularity is calculated from the popularity of all the artist’s tracks.
- * @property type The object type: "artist"
+ * @param type The object type: "artist"
  */
 @Serializable
 public data class Artist(

src/commonMain/kotlin/com.adamratzman.spotify/models/Authentication.kt

@@ -11,12 +11,13 @@ import kotlinx.serialization.Transient
 /**
  * Represents a Spotify Token, retrieved through instantiating a [SpotifyApi]
  *
- * @property accessToken An access token that can be provided in subsequent calls,
+ * @param accessToken An access token that can be provided in subsequent calls,
  * for example to Spotify Web API services.
- * @property tokenType How the access token may be used: always “Bearer”.
- * @property expiresIn The time period (in seconds) for which the access token is valid.
- * @property refreshToken A token that can be sent to the Spotify Accounts service in place of an authorization code,
+ * @param tokenType How the access token may be used: always “Bearer”.
+ * @param expiresIn The time period (in seconds) for which the access token is valid.
+ * @param refreshToken A token that can be sent to the Spotify Accounts service in place of an authorization code,
  * null if the token was created using a method that does not support token refresh
+ *
  * @property scopes A list of scopes granted access for this [accessToken]. An
  * empty list means that the token can only be used to access public information.
  * @property expiresAt The time, in milliseconds, at which this Token expires

src/commonMain/kotlin/com.adamratzman.spotify/models/Browse.kt

@@ -45,17 +45,17 @@ public data class RecommendationSeed(
 ) : Identifiable()
 
 /**
- * @property seeds An array of recommendation seed objects.
- * @property tracks An array of track object (simplified) ordered according to the parameters supplied.
+ * @param seeds An array of recommendation seed objects.
+ * @param tracks An array of track object (simplified) ordered according to the parameters supplied.
  */
 @Serializable
 public data class RecommendationResponse(val seeds: List<RecommendationSeed>, val tracks: List<Track>)
 
 /**
  * Spotify featured playlists (on the Browse tab)
  *
- * @property message the featured message in "Overview"
- * @property playlists [PagingObject] of returned items
+ * @param message the featured message in "Overview"
+ * @param playlists [PagingObject] of returned items
  */
 @Serializable
 public data class FeaturedPlaylists(val message: String, val playlists: PagingObject<SimplePlaylist>)