Tweaked KDoc comments

Author: bastianeicher

typedrest/src/main/kotlin/net/typedrest/URIExtensions.kt

@@ -16,7 +16,7 @@ fun URI.ensureTrailingSlash(): URI =
 /**
  * Resolves a relative URI using this URI as the base.
  *
- * @param relativeUri The relative URI to resolve. Prepend "./" to imply a trailing slash in the base URI even if it is missing there.
+ * @param relativeUri The relative URI to resolve. Add a `./` prefix here to imply a trailing slash in the base URI even if it is missing there.
  */
 fun URI.join(relativeUri: String): URI =
     if (relativeUri.startsWith("./")) {
@@ -28,7 +28,7 @@ fun URI.join(relativeUri: String): URI =
 /**
  * Resolves a relative URI using this URI as the base.
  *
- * @param relativeUri The relative URI to resolve. Prepend "./" to imply a trailing slash in the base URI even if it is missing there.
+ * @param relativeUri The relative URI to resolve. Add a `./` prefix here to imply a trailing slash in the base URI even if it is missing there.
  */
 fun URI.join(relativeUri: URI): URI =
     if (relativeUri.toString().startsWith("./")) {

typedrest/src/main/kotlin/net/typedrest/endpoints/AbstractEndpoint.kt

@@ -30,7 +30,7 @@ abstract class AbstractEndpoint(
      * Creates a new endpoint with a relative URI.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s.
      */
     constructor(referrer: Endpoint, relativeUri: URI) : this(
         referrer.uri.join(relativeUri),

typedrest/src/main/kotlin/net/typedrest/endpoints/generic/AbstractCachingEndpoint.kt

@@ -10,7 +10,7 @@ import java.net.URI
  * Base class for building endpoints that use ETags and Last-Modified timestamps for caching and to avoid lost updates.
  *
  * @param referrer The endpoint used to navigate to this one.
- * @param relativeUri The URI of this endpoint relative to the referrer's.
+ * @param relativeUri The URI of this endpoint relative to the [referrer]'s.
  */
 abstract class AbstractCachingEndpoint(referrer: Endpoint, relativeUri: URI) :
     AbstractEndpoint(referrer, relativeUri), CachingEndpoint {

typedrest/src/main/kotlin/net/typedrest/endpoints/generic/CollectionEndpointImpl.kt

@@ -15,7 +15,7 @@ open class CollectionEndpointImpl<TEntity> : GenericCollectionEndpointImpl<TEnti
      * Creates a new element collection endpoint.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s.
      * @param entityType The type of individual elements in the collection.
      */
     constructor(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>)
@@ -25,7 +25,7 @@ open class CollectionEndpointImpl<TEntity> : GenericCollectionEndpointImpl<TEnti
      * Creates a new element collection endpoint.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
      * @param entityType The type of individual elements in the collection.
      */
     constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>)

typedrest/src/main/kotlin/net/typedrest/endpoints/generic/ElementEndpointImpl.kt

@@ -10,7 +10,7 @@ import java.net.URI
  * Endpoint for an individual resource.
  *
  * @param referrer The endpoint used to navigate to this one.
- * @param relativeUri The URI of this endpoint relative to the referrer's.
+ * @param relativeUri The URI of this endpoint relative to the [referrer]'s.
  * @param entityType The type of entity the endpoint represents.
  * @param TEntity The type of entity the endpoint represents.
  */
@@ -23,7 +23,7 @@ open class ElementEndpointImpl<TEntity>(
      * Creates a new element endpoint.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
      * @param entityType The type of entity the endpoint represents.
      */
     constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>) :

typedrest/src/main/kotlin/net/typedrest/endpoints/generic/GenericCollectionEndpointImpl.kt

@@ -13,7 +13,7 @@ import java.net.URLEncoder
  * Use the more constrained [CollectionEndpointImpl] when possible.
  *
  * @param referrer The endpoint used to navigate to this one.
- * @param relativeUri The URI of this endpoint relative to the referrer's.
+ * @param relativeUri The URI of this endpoint relative to the [referrer]'s.
  * @param entityType The type of individual elements in the collection.
  * @param elementEndpointFactory The factory for constructing [TElementEndpoint]s to provide for individual elements.
  * @param TEntity The type of individual elements in the collection.
@@ -29,7 +29,7 @@ open class GenericCollectionEndpointImpl<TEntity, TElementEndpoint : ElementEndp
      * Creates a new element collection endpoint.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
      * @param entityType The type of individual elements in the collection.
      * @param elementEndpointFactory The factory for constructing [TElementEndpoint]s to provide for individual elements.
      */

typedrest/src/main/kotlin/net/typedrest/endpoints/generic/IndexerEndpointImpl.kt

@@ -9,7 +9,7 @@ import java.net.URLEncoder
  * Endpoint that addresses child [TElementEndpoint]s by ID.
  *
  * @param referrer The endpoint used to navigate to this one.
- * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+ * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
  * @param elementEndpointFactory The factory for constructing [TElementEndpoint]s to provide for individual elements.
  * @param TElementEndpoint The type of [Endpoint] to provide for individual elements.
  */
@@ -22,7 +22,7 @@ open class IndexerEndpointImpl<TElementEndpoint : Endpoint>(
      * Creates a new indexer endpoint.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
      * @param elementEndpointFactory The factory for constructing [TElementEndpoint]s to provide for individual elements.
      */
     constructor(referrer: Endpoint, relativeUri: String, elementEndpointFactory: (referrer: Endpoint, relativeUri: URI) -> TElementEndpoint) :

typedrest/src/main/kotlin/net/typedrest/endpoints/raw/BlobEndpointImpl.kt

@@ -12,14 +12,14 @@ import java.net.URI
  * Endpoint for a binary blob that can be downloaded or uploaded.
  *
  * @param referrer The endpoint used to navigate to this one.
- * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+ * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
  */
 open class BlobEndpointImpl(referrer: Endpoint, relativeUri: URI) : AbstractEndpoint(referrer, relativeUri), BlobEndpoint {
     /**
      * Creates a new blob endpoint.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
      */
     constructor(referrer: Endpoint, relativeUri: String) :
         this(referrer, URI(relativeUri))

typedrest/src/main/kotlin/net/typedrest/endpoints/raw/UploadEndpointImpl.kt

@@ -11,9 +11,9 @@ import java.net.URI
 /**
  * Implementation of an [UploadEndpoint] that accepts binary uploads using multi-part form encoding or raw bodies.
  *
- * @property referrer The endpoint used to navigate to this one.
- * @property relativeUri The URI of this endpoint relative to the [referrer]'s.
- * @property formField The name of the form field to place the uploaded data into; null to use raw bodies instead of multi-part forms.
+ * @param referrer The endpoint used to navigate to this one.
+ * @param relativeUri The URI of this endpoint relative to the [referrer]'s.
+ * @param formField The name of the form field to place the uploaded data into; null to use raw bodies instead of multi-part forms.
  */
 class UploadEndpointImpl(
     private val referrer: Endpoint,
@@ -24,8 +24,8 @@ class UploadEndpointImpl(
      * Creates a new upload endpoint.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
-     * @property formField The name of the form field to place the uploaded data into; null to use raw bodies instead of multi-part forms.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
+     * @param formField The name of the form field to place the uploaded data into; null to use raw bodies instead of multi-part forms.
      */
     constructor(referrer: Endpoint, relativeUri: String, formField: String? = null) :
         this(referrer, URI(relativeUri), formField)

typedrest/src/main/kotlin/net/typedrest/endpoints/rpc/AbstractRpcEndpoint.kt

@@ -9,14 +9,14 @@ import java.net.URI
  * Base class for building RPC endpoints.
  *
  * @param referrer The endpoint used to navigate to this one.
- * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+ * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
  */
 abstract class AbstractRpcEndpoint(referrer: Endpoint, relativeUri: URI) : AbstractEndpoint(referrer, relativeUri), RpcEndpoint {
     /**
      * Creates a new RPC endpoint with a relative URI.
      *
      * @param referrer The endpoint used to navigate to this one.
-     * @param relativeUri The URI of this endpoint relative to the referrer's. Add a "./" prefix here to imply a trailing slash on referrer's URI.
+     * @param relativeUri The URI of this endpoint relative to the [referrer]'s. Add a `./` prefix here to imply a trailing slash on referrer's URI.
      */
     constructor(referrer: Endpoint, relativeUri: String) :
         this(referrer, URI(relativeUri))