add scope references in kdocs

Author: adamint

src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/SearchApi.kt

@@ -21,6 +21,7 @@ import com.adamratzman.spotify.models.serialization.toPagingObject
 import com.adamratzman.spotify.utils.Market
 import kotlinx.serialization.json.JsonObject
 import kotlinx.serialization.serializer
+import com.adamratzman.spotify.SpotifyScope
 
 @Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("SearchApi"))
 typealias SearchAPI = SearchApi
@@ -100,7 +101,7 @@ class SearchApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
      * @param market If a country code is specified, only artists, albums, and tracks with content that is playable in that market is returned. Note:
     - Playlist results are not affected by the market parameter.
     - If market is set to from_token, and a valid access token is specified in the request header, only content playable in the country associated with the user account, is returned.
-    - Users can view the country that is associated with their account in the account settings. A user must grant access to the user-read-private scope prior to when the access token is issued.
+    - Users can view the country that is associated with their account in the account settings. A user must grant access to the [SpotifyScope.USER_READ_PRIVATE] scope prior to when the access token is issued.
      * @param includeExternal If true, the response will include any relevant audio content that is hosted externally. By default external content is filtered out from responses.
      */
     fun search(

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

@@ -1,27 +1,28 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2020; Original author: Adam Ratzman */
 package com.adamratzman.spotify.models
 
+import com.adamratzman.spotify.SpotifyScope
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
 /**
  * Private information about a Spotify user. Each field may require a specific scope.
  *
  * @property birthdate The user’s date-of-birth. This field is only available when the current user
- * has granted access to the user-read-birthdate scope.
+ * has granted access to the [SpotifyScope.USER_READ_BIRTHDATE] scope.
  * @property country The country of the user, as set in the user’s account profile. An ISO 3166-1 alpha-2
- * country code. This field is only available when the current user has granted access to the user-read-private scope.
+ * country code. This field is only available when the current user has granted access to the [SpotifyScope.USER_READ_PRIVATE] scope.
  * @property displayName The name displayed on the user’s profile. null if not available.
  * @property email The user’s email address, as entered by the user when creating their account. Important! This email
  * address is unverified; there is no proof that it actually belongs to the user. This field is only
- * available when the current user has granted access to the user-read-email scope.
+ * available when the current user has granted access to the [SpotifyScope.USER_READ_EMAIL] scope.
  * @property followers Information about the followers of the user.
  * @property href A link to the Web API endpoint for this user.
  * @property id The Spotify user ID for the user
  * @property images The user’s profile image.
  * @property product The user’s Spotify subscription level: “premium”, “free”, etc.
  * (The subscription level “open” can be considered the same as “free”.) This field is only available when the
- * current user has granted access to the user-read-private scope.
+ * current user has granted access to the [SpotifyScope.USER_READ_PRIVATE] scope.
  * @property type The object type: “user”
  */
 @Serializable