Improved the source code documentation of the source code in the package.

This commit is contained in:
2026-03-24 01:26:27 +01:00
parent 25b62a4f67
commit a559ae0163
14 changed files with 50 additions and 24 deletions
@@ -16,7 +16,7 @@ extension String {
/// An empty string.
static let empty = ""
/// A namespaces assigned for the names of parameters.
/// A namespace for the names of parameters.
enum Parameter {
/// A name for the consumer key.
static let key = "key"
@@ -25,9 +25,9 @@ extension String {
/// A name for the user token.
static let token = "token"
}
/// A namespaces assigned for the formats of string values.
/// A namespace for the formats of string values.
enum Format {}
/// A namespaces assigned for the formats of regular expression patterns.
/// A namespace for the formats of regular expression patterns.
enum Pattern {}
}
@@ -52,7 +52,7 @@ private extension CamelCaseValidationRule {
///
/// - Parameter input: An input to be validated.
/// - Returns: A flag that indicates whether a given input has been validated or not.
/// - Throws: An error of type ``InputValidatorError`` in case the validation failed.
/// - Throws: An error of type ``InputValidationError`` in case the validation failed.
func validate(input: String?) throws -> Bool {
guard let input else {
return false
@@ -52,7 +52,7 @@ private extension NotEmptyValidationRule {
///
/// - Parameter input: An input to be validated.
/// - Returns: A flag that indicates whether a given input has been validated or not.
/// - Throws: An error of type ``InputValidatorError`` in case the validation failed.
/// - Throws: An error of type ``InputValidationError`` in case the validation failed.
func validate(input: String?) throws -> Bool {
guard let input else {
return false
@@ -52,7 +52,7 @@ private extension NotNilValidationRule {
///
/// - Parameter input: An input to be validated.
/// - Returns: A flag that indicates whether a given input has been validated or not.
/// - Throws: An error of type ``InputValidatorError`` in case the validation failed.
/// - Throws: An error of type ``InputValidationError`` in case the validation failed.
func validate(input: String?) throws -> Bool {
guard input != nil else {
throw InputValidationError.inputIsNil
@@ -65,9 +65,9 @@ extension InputValidationRule where Self == SecureValidationRule {
enum SecurityInput: Int {
/// A consumer key is 20 characters long.
case consumerKey = 20
/// A consumer key is 32 characters long.
/// A consumer secret is 32 characters long.
case consumerSecret = 32
/// A consumer key is 40 characters long.
/// A user token is 40 characters long.
case userToken = 40
}
@@ -83,7 +83,7 @@ private extension SecureValidationRule {
///
/// - Parameter input: An input to be validated.
/// - Returns: A flag that indicates whether a given input has been validated or not.
/// - Throws: An error of type ``InputValidatorError`` in case the validation failed.
/// - Throws: An error of type ``InputValidationError`` in case the validation failed.
func validate(input: String?) throws -> Bool {
guard let input else {
return false
@@ -54,7 +54,7 @@ private extension SemanticVersionValidationRule {
///
/// - Parameter input: An input to be validated.
/// - Returns: A flag that indicates whether a given input has been validated or not.
/// - Throws: An error of type ``InputValidatorError`` in case the validation failed.
/// - Throws: An error of type ``InputValidationError`` in case the validation failed.
func validate(input: String?) throws -> Bool {
guard let input else {
return false
@@ -56,7 +56,7 @@ private extension URLValidationRule {
///
/// - Parameter input: An input to be validated.
/// - Returns: A flag that indicates whether a given input has been validated or not.
/// - Throws: An error of type ``InputValidatorError`` in case the validation failed.
/// - Throws: An error of type ``InputValidationError`` in case the validation failed.
func validate(input: String?) throws -> Bool {
guard let input else {
return false