From 73842b06284a4d74eeed7a3f56261e868ec620ee Mon Sep 17 00:00:00 2001 From: David Patterson Date: Fri, 15 Apr 2016 17:17:59 -0500 Subject: [PATCH] updated docs to reflect current codebase fixes #102 --- docs/Classes.html | 214 ++++++++++++- docs/Classes/AlphaNumericRule.html | 192 ++++++++++++ docs/Classes/AlphaRule.html | 192 ++++++++++++ docs/Classes/CharacterSetRule.html | 288 ++++++++++++++++++ docs/Classes/ConfirmationRule.html | 20 +- docs/Classes/EmailRule.html | 20 +- docs/Classes/ExactLengthRule.html | 20 +- docs/Classes/FloatRule.html | 20 +- docs/Classes/FullNameRule.html | 20 +- docs/Classes/HexColorRule.html | 191 ++++++++++++ docs/Classes/IPV4Rule.html | 191 ++++++++++++ docs/Classes/ISBNRule.html | 275 +++++++++++++++++ docs/Classes/MaxLengthRule.html | 25 +- docs/Classes/MinLengthRule.html | 25 +- docs/Classes/PasswordRule.html | 20 +- docs/Classes/PhoneNumberRule.html | 24 +- docs/Classes/RegexRule.html | 20 +- docs/Classes/RequiredRule.html | 23 +- docs/Classes/ValidationError.html | 31 +- docs/Classes/ValidationRule.html | 20 +- docs/Classes/Validator.html | 24 +- docs/Classes/ZipCodeRule.html | 20 +- docs/Protocols.html | 20 +- docs/Protocols/Rule.html | 20 +- docs/Protocols/ValidationDelegate.html | 26 +- .../Contents/Resources/Documents/Classes.html | 214 ++++++++++++- .../Documents/Classes/AlphaNumericRule.html | 192 ++++++++++++ .../Documents/Classes/AlphaRule.html | 192 ++++++++++++ .../Documents/Classes/CharacterSetRule.html | 288 ++++++++++++++++++ .../Documents/Classes/ConfirmationRule.html | 20 +- .../Documents/Classes/EmailRule.html | 20 +- .../Documents/Classes/ExactLengthRule.html | 20 +- .../Documents/Classes/FloatRule.html | 20 +- .../Documents/Classes/FullNameRule.html | 20 +- .../Documents/Classes/HexColorRule.html | 191 ++++++++++++ .../Resources/Documents/Classes/IPV4Rule.html | 191 ++++++++++++ .../Resources/Documents/Classes/ISBNRule.html | 275 +++++++++++++++++ .../Documents/Classes/MaxLengthRule.html | 25 +- .../Documents/Classes/MinLengthRule.html | 25 +- .../Documents/Classes/PasswordRule.html | 20 +- .../Documents/Classes/PhoneNumberRule.html | 24 +- .../Documents/Classes/RegexRule.html | 20 +- .../Documents/Classes/RequiredRule.html | 23 +- .../Documents/Classes/ValidationError.html | 31 +- .../Documents/Classes/ValidationRule.html | 20 +- .../Documents/Classes/Validator.html | 24 +- .../Documents/Classes/ZipCodeRule.html | 20 +- .../Resources/Documents/Protocols.html | 20 +- .../Resources/Documents/Protocols/Rule.html | 20 +- .../Protocols/ValidationDelegate.html | 26 +- .../Contents/Resources/Documents/index.html | 27 +- .../Contents/Resources/docSet.dsidx | Bin 28672 -> 36864 bytes docs/docsets/SwiftValidator.tgz | Bin 57780 -> 61135 bytes docs/index.html | 27 +- 54 files changed, 3836 insertions(+), 100 deletions(-) create mode 100644 docs/Classes/AlphaNumericRule.html create mode 100644 docs/Classes/AlphaRule.html create mode 100644 docs/Classes/CharacterSetRule.html create mode 100644 docs/Classes/HexColorRule.html create mode 100644 docs/Classes/IPV4Rule.html create mode 100644 docs/Classes/ISBNRule.html create mode 100644 docs/docsets/SwiftValidator.docset/Contents/Resources/Documents/Classes/AlphaNumericRule.html create mode 100644 docs/docsets/SwiftValidator.docset/Contents/Resources/Documents/Classes/AlphaRule.html create mode 100644 docs/docsets/SwiftValidator.docset/Contents/Resources/Documents/Classes/CharacterSetRule.html create mode 100644 docs/docsets/SwiftValidator.docset/Contents/Resources/Documents/Classes/HexColorRule.html create mode 100644 docs/docsets/SwiftValidator.docset/Contents/Resources/Documents/Classes/IPV4Rule.html create mode 100644 docs/docsets/SwiftValidator.docset/Contents/Resources/Documents/Classes/ISBNRule.html diff --git a/docs/Classes.html b/docs/Classes.html index 57ca096..8b7f89c 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -29,6 +29,15 @@
  • Classes +
    +
      +
    • +
      + + + + AlphaNumericRule + +
      +
      +
      +
      +
      +
      +

      AlphaNumericRule is a subclass of CharacterSetRule. It is used to verify that a field has a +valid list of alphanumeric characters.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class AlphaNumericRule: CharacterSetRule
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + CharacterSetRule + +
      +
      +
      +
      +
      +
      +

      CharacterSetRule is a subclass of Rule. It is used to validate IPV4 address fields.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class CharacterSetRule: Rule
      + +
      +
      +
      +
      +
      • +
    +
    • @@ -289,6 +372,38 @@
    +
    +
      +
    • +
      + + + + HexColorRule + +
      +
      +
      +
      +
      +
      +

      HexColorRule is a subclass of RegexRule. It is used to verify whether a field is a hexadecimal color.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class HexColorRule: RegexRule
      + +
      +
      +
      +
      +
      • +
    +
    • @@ -387,6 +502,70 @@ to another text field is validated.

    +
    +
      +
    • +
      + + + + IPV4Rule + +
      +
      +
      +
      +
      +
      +

      IPV4Rule is a subclass of RegexRule that defines how a IPV4 address validated.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class IPV4Rule: RegexRule
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + ISBNRule + +
      +
      +
      +
      +
      +
      +

      ISBNRule is a subclass of Rule. It is used to verify whether a field is a valid ISBN number.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class ISBNRule: Rule
      + +
      +
      +
      +
      +
      • +
    +
    • @@ -483,6 +662,39 @@ to another text field is validated.

    +
    +
      +
    • +
      + + + + AlphaRule + +
      +
      +
      +
      +
      +
      +

      AlphaRule is a subclass of CharacterSetRule. It is used to verify that a field has a +valid list of alpha characters.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class AlphaRule: CharacterSetRule
      + +
      +
      +
      +
      +
      • +
    +
    + diff --git a/docs/Classes/AlphaRule.html b/docs/Classes/AlphaRule.html new file mode 100644 index 0000000..71f1d81 --- /dev/null +++ b/docs/Classes/AlphaRule.html @@ -0,0 +1,192 @@ + + + + AlphaRule Class Reference + + + + + + + + + + +
    +
    +

    SwiftValidator Docs (100% documented)

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    AlphaRule

    +
    +
    + 
    public class AlphaRule: CharacterSetRule
    + +
    +
    +

    AlphaRule is a subclass of CharacterSetRule. It is used to verify that a field has a +valid list of alpha characters.

    + +
    +
    +
    +
      +
    • +
      + + + + init(message:) + +
      +
      +
      +
      +
      +
      +

      Initializes an AlphaRule object to verify that a field has valid set of alpha characters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(message: String = "Enter valid alphabetic characters")
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + message + + +
      +

      String of error message.

      + +
      +
      +
      +
      +

      Return Value

      +

      An initialized object, or nil if an object could not be created for some reason.

      + +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Classes/CharacterSetRule.html b/docs/Classes/CharacterSetRule.html new file mode 100644 index 0000000..c472ede --- /dev/null +++ b/docs/Classes/CharacterSetRule.html @@ -0,0 +1,288 @@ + + + + CharacterSetRule Class Reference + + + + + + + + + + +
    +
    +

    SwiftValidator Docs (100% documented)

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    CharacterSetRule

    +
    +
    + 
    public class CharacterSetRule: Rule
    + +
    +
    +

    CharacterSetRule is a subclass of Rule. It is used to validate IPV4 address fields.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a CharacterSetRule object to verify that field has valid set of characters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(characterSet: NSCharacterSet, message: String = "Enter valid alpha")
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + characterSet + + +
      +

      NSCharacterSet that holds group of valid characters.

      + +
      +
      + + message + + +
      +

      String of error message.

      + +
      +
      +
      +
      +

      Return Value

      +

      An initialized object, or nil if an object could not be created for some reason that would not result in an exception.

      + +
      +
      +
      +
      • +
    • +
      + + + + validate(_:) + +
      +
      +
      +
      +
      +
      +

      Used to validate field.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func validate(value: String) -> Bool
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + value + + +
      +

      String to checked for validation.

      + +
      +
      +
      +
      +

      Return Value

      +

      Boolean value. True if validation is successful; False if validation fails.

      + +
      +
      +
      +
      • +
    • +
      + + + + errorMessage() + +
      +
      +
      +
      +
      +
      +

      Displays error message when text field fails validation.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func errorMessage() -> String
      + +
      +
      +
      +

      Return Value

      +

      String of error message.

      + +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Classes/ConfirmationRule.html b/docs/Classes/ConfirmationRule.html index 9bc59da..265e6c1 100644 --- a/docs/Classes/ConfirmationRule.html +++ b/docs/Classes/ConfirmationRule.html @@ -30,6 +30,15 @@
  • Classes