From 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Thu, 1 Dec 2011 14:11:42 +0900 Subject: removing generated yard docs from repository --- doc/Axlsx/RestrictionValidator.html | 292 ------------------------------------ 1 file changed, 292 deletions(-) delete mode 100644 doc/Axlsx/RestrictionValidator.html (limited to 'doc/Axlsx/RestrictionValidator.html') diff --git a/doc/Axlsx/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html deleted file mode 100644 index a5a2bb53..00000000 --- a/doc/Axlsx/RestrictionValidator.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - Class: Axlsx::RestrictionValidator - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::RestrictionValidator - - - -

- -
- -
Inherits:
-
- Object - -
    -
  • Object
    • - - - -
- show all - -
- - - - - - - - - -
Defined in:
-
lib/axlsx/util/validators.rb
- -
-
- -

Overview

-
- -

Validate a value against a specific list of allowed values.

- - -
-
-
- - -
- - - - - -

- Class Method Summary - (collapse) -

- - - - - - -
-

Class Method Details

- - -
-

- - + (Boolean) validate(name, choices, v) - - - -

-
- -

Perform validation

- - -
-
-
-

Parameters:

-
    - -
  • - - name - - - (String) - - - - — -
    -

    The name of what is being validatied. This is included in the error message

    -
    - -
    • - -
  • - - choices - - - (Array) - - - - — -
    -

    The list of choices to validate against

    -
    - -
    • - -
  • - - v - - - (Any) - - - - — -
    -

    The value to be validated

    -
    - -
    • - -
- -

Returns:

-
    - -
  • - - - (Boolean) - - - - — -
    -

    true if validation succeeds.

    -
    - -
    • - -
-

Raises:

-
    - -
  • - - - (ArgumentError) - - - - — -
    -

    Raised if the value provided is not in the list of choices.

    -
    - -
    • - -
- -
- - - - -
- 
-
-
-10
-11
-12
-13
- 		- 
# File 'lib/axlsx/util/validators.rb', line 10
-
-def self.validate(name, choices, v)
-  raise ArgumentError, (ERR_RESTRICTION % [v.to_s, name, choices.inspect]) unless choices.include?(v)      
-  true
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3