Update command symbol docs to use DocC symbol references

Author: Mordil

Sources/RediStack/Commands/ConnectionCommands.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2020 RediStack project authors
+// Copyright (c) 2020-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -60,7 +60,7 @@ extension RedisCommand {
 extension RedisClient {
     /// Pings the server, which will respond with a message.
     ///
-    /// See `RedisCommand.ping(with:)`
+    /// See ``RedisCommand/ping(with:)``
     /// - Parameter message: The optional message that the server should respond with instead of the default.
     /// - Returns: A `NIO.EventLoopFuture` that resolves the given `message` or Redis' default response of `PONG`.
     public func ping(with message: String? = nil) -> EventLoopFuture<String> {
@@ -69,7 +69,7 @@ extension RedisClient {
 
     /// Requests the client to authenticate with Redis to allow other commands to be executed.
     ///
-    /// See `RedisCommand.auth(with:)`
+    /// See ``RedisCommand/auth(with:)``
     /// - Parameter password: The password to authenticate with.
     /// - Returns: A `NIO.EventLoopFuture` that resolves if the password as accepted, otherwise it fails.
     public func authorize(with password: String) -> EventLoopFuture<Void> {
@@ -78,7 +78,7 @@ extension RedisClient {
 
     /// Selects the Redis logical database having the given zero-based numeric index.
     ///
-    /// See `RedisCommand.select(database:)`
+    /// See ``RedisCommand/select(database:)``
     /// - Note: New connections always use the database `0`.
     /// - Parameter index: The 0-based index of the database that the connection sending this command will execute later commands against.
     /// - Returns: A `NIO.EventLoopFuture` resolving once the operation has succeeded.

Sources/RediStack/Commands/HashCommands.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2019-2020 RediStack project authors
+// Copyright (c) 2019-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -148,7 +148,7 @@ extension RedisCommand {
     }
 
     /// [HSET](https://redis.io/commands/hset)
-    /// - Note: If you do not want to overwrite existing values, use `hsetnx(_:field:to:)`.
+    /// - Note: If you do not want to overwrite existing values, use ``hsetnx(_:field:to:)``.
     /// - Parameters:
     ///     - field: The key of the field in the hash being set.
     ///     - value: The value the hash field should be set to.
@@ -168,7 +168,7 @@ extension RedisCommand {
     }
 
     /// [HSETNX](https://redis.io/commands/hsetnx)
-    /// - Note: If you do not care about overwriting existing values, use `hset(_:field:to:)`.
+    /// - Note: If you do not care about overwriting existing values, use ``hset(_:field:to:)``.
     /// - Parameters:
     ///     - field: The key of the field in the hash being set.
     ///     - value: The value the hash field should be set to.
@@ -231,7 +231,7 @@ extension RedisCommand {
 extension RedisClient {
     /// Incrementally iterates over all fields in a hash.
     ///
-    /// See `RedisCommand.hscan(_:startingFrom:matching:count:)`
+    /// See ``RedisCommand/hscan(_:startingFrom:matching:count:)``
     /// - Parameters:
     ///     - key: The key of the hash.
     ///     - position: The position to start the scan from.

Sources/RediStack/Commands/KeyCommands.swift

@@ -93,7 +93,7 @@ extension RedisCommand {
 extension RedisClient {
     /// Deletes the given keys. Any key that does not exist is ignored.
     ///
-    /// See `RedisCommand.del(keys:)`
+    /// See ``RedisCommand/.del(keys:)``
     /// - Parameter keys: The list of keys to delete from the database.
     /// - Returns: A `NIO.EventLoopFuture` that resolves the number of keys that were deleted from the database.
     public func delete(_ keys: RedisKey...) -> EventLoopFuture<Int> {
@@ -102,7 +102,7 @@ extension RedisClient {
 
     /// Deletes the given keys. Any key that does not exist is ignored.
     ///
-    /// See `RedisCommand.del(keys:)`
+    /// See ``RedisCommand/del(keys:)``
     /// - Parameter keys: The list of keys to delete from the database.
     /// - Returns: A `NIO.EventLoopFuture` that resolves the number of keys that were deleted from the database.
     public func delete(_ keys: [RedisKey]) -> EventLoopFuture<Int> {
@@ -112,7 +112,7 @@ extension RedisClient {
 
     /// Sets a timeout on key. After the timeout has expired, the key will automatically be deleted.
     ///
-    /// See `RedisCommand.expire(_:after:)`
+    /// See ``RedisCommand/expire(_:after:)``
     /// - Parameters:
     ///     - key: The key to set the expiration on.
     ///     - timeout: The time from now the key will expire at.
@@ -125,14 +125,14 @@ extension RedisClient {
     ///
     /// See ``RedisCommand/keys(matching:)``
     /// - Parameter pattern: The key pattern to search for matching keys that exist in Redis.
-    /// - Returns: A list of keys that matched the provided pattern.
+    /// - Returns: A result set of ``RedisKey`` values that exist and match the provided pattern.
     public func listKeys(matching pattern: String) -> EventLoopFuture<[RedisKey]> {
         return self.send(.keys(matching: pattern))
     }
 
     /// Incrementally iterates over all keys in the currently selected database.
     ///
-    /// See `RedisCommand.scan(startingFrom:matching:count:)`
+    /// See ``RedisCommand/scan(startingFrom:matching:count:)``
     /// - Parameters:
     ///     - position: The cursor position to start from.
     ///     - match: A glob-style pattern to filter values to be selected from the result set.

Sources/RediStack/Commands/ListCommands.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2019-2020 RediStack project authors
+// Copyright (c) 2019-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -193,7 +193,7 @@ extension RedisCommand {
     ) -> RedisCommand<Int> { .lpush(elements, into: key) }
 
     /// [LPUSHX](https://redis.io/commands/lpushx)
-    /// - Note: This inserts the element at the head of the list, for the tail see `rpushx(_:into:)`.
+    /// - Note: This inserts the element at the head of the list, for the tail see ``rpushx(_:into:)``.
     /// - Parameters:
     ///     - element: The value to try and push into the list.
     ///     - key: The key of the list.
@@ -239,7 +239,7 @@ extension RedisCommand {
     /// - Precondition: A `ClosedRange` cannot be created where `upperBound` is less than `lowerBound`; so while Redis may support `0...-1`,
     ///     `ClosedRange` will trigger a precondition failure.
     ///
-    ///     If you need such a range, use `lrange(from:firstIndex:lastIndex:)` instead.
+    ///     If you need such a range, use ``lrange(from:firstIndex:lastIndex:)`` instead.
     /// - Parameters:
     ///     - key: The key of the List to return elements from.
     ///     - range: The range of inclusive indices of elements to get.
@@ -266,7 +266,7 @@ extension RedisCommand {
     /// - Precondition: A `Range` cannot be created where `upperBound` is less than `lowerBound`; so while Redis may support `0..<(-1)`,
     ///     `Range` will trigger a precondition failure.
     ///
-    ///     If you need such a range, use `lrange(from:firstIndex:lastIndex:)` instead.
+    ///     If you need such a range, use ``lrange(from:firstIndex:lastIndex:)`` instead.
     /// - Parameters:
     ///     - key: The key of the List to return elements from.
     ///     - range: The range of indices (inclusive lower, exclusive upper) elements to get.
@@ -394,7 +394,7 @@ extension RedisCommand {
     /// - Precondition: A `ClosedRange` cannot be created where `upperBound` is less than `lowerBound`; so while Redis may support `0...-1`,
     ///     `ClosedRange` will trigger a precondition failure.
     ///
-    ///     If you need such a range, use `ltrim(_:before:after:)` instead.
+    ///     If you need such a range, use ``ltrim(_:before:after:)`` instead.
     /// - Parameters:
     ///     - key: The key of the List to trim.
     ///     - range: The range of indices that should be kept in the List.
@@ -515,7 +515,7 @@ extension RedisCommand {
     }
 
     /// [RPUSHX](https://redis.io/commands/rpushx)
-    /// - Note: This inserts the element at the tail of the list; for the head see `lpushx(_:into:)`.
+    /// - Note: This inserts the element at the tail of the list; for the head see ``lpushx(_:into:)``.
     /// - Parameters:
     ///     - element: The value to try and push into the list.
     ///     - key: The key of the list.

Sources/RediStack/Commands/PubSubCommands.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2020 RediStack project authors
+// Copyright (c) 2020-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -82,7 +82,7 @@ extension RedisCommand {
 extension RedisClient {
     /// Publishes the provided message to a specific Redis channel.
     ///
-    /// See `RedisCommand.publish(_:to:)`
+    /// See ``RedisCommand/publish(_:to:)``
     /// - Parameters:
     ///     - message: The "message" value to publish on the channel.
     ///     - channel: The name of the channel to publish the message to.

Sources/RediStack/Commands/RedisCommand.swift

@@ -17,10 +17,10 @@
 /// An instance will retain the keyword of the command in plaintext as a `String` for identity purposes,
 /// while all the arguments will be stored as `RESPValue` representations.
 ///
-/// ## ResultType
-/// Each `RedisCommand` has a generic type referred to as `ResultType` that is the native Swift representation of the response Redis will send for the command.
+/// Each `RedisCommand` has a generic type referred to as `ResultType` that is the native Swift representation
+/// of the final result type parsed from the Redis command response.
 ///
-/// When creating a `RedisCommand`, a closure will be provided for transforming an arbitrary `RESPValue` instance into the `ResultType`.
+/// When creating a `RedisCommand`, a closure is provided for transforming an arbitrary `RESPValue` instance into the `ResultType`.
 public struct RedisCommand<ResultType> {
     public let keyword: String
     public let arguments: [RESPValue]

Sources/RediStack/Commands/ServerCommands.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2020 RediStack project authors
+// Copyright (c) 2020-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -37,7 +37,7 @@ extension RedisCommand {
 extension RedisClient {
     /// Swaps the data of two Redis databases by their index IDs.
     ///
-    /// See `RedisCommand.swapdb(_:with:)`
+    /// See ``RedisCommand/swapdb(_:with:)``
     /// - Parameters:
     ///     - first: The index of the first database.
     ///     - second: The index of the second database.

Sources/RediStack/Commands/SetCommands.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2019-2020 RediStack project authors
+// Copyright (c) 2019-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -248,7 +248,7 @@ extension RedisCommand {
 extension RedisClient {
     /// Incrementally iterates over all values in a set.
     ///
-    /// See `RedisCommand.sscan(_:startingFrom:matching:count:)`
+    /// See ``RedisCommand/sscan(_:startingFrom:matching:count:)``
     /// - Parameters:
     ///     - key: The key of the set.
     ///     - position: The position to start the scan from.