Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chrs1885 committed Apr 26, 2019
1 parent b3a126f commit b619faf
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 3 deletions.
4 changes: 4 additions & 0 deletions Documentation/Reference/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Reference Documentation
This Reference Documentation has been generated with
[SourceDocs](https://github.com/eneko/SourceDocs).

## Protocols

Expand All @@ -11,6 +13,7 @@

## Classes

- [GrayscaleColor](classes/GrayscaleColor.md)
- [HSBAColor](classes/HSBAColor.md)
- [RGBAColor](classes/RGBAColor.md)

Expand All @@ -20,6 +23,7 @@

## Extensions

- [GrayscaleColor](extensions/GrayscaleColor.md)
- [HSBAColor](extensions/HSBAColor.md)
- [RGBAColor](extensions/RGBAColor.md)
- [SheetyColorsController](extensions/SheetyColorsController.md)
Expand Down
50 changes: 50 additions & 0 deletions Documentation/Reference/classes/GrayscaleColor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
**CLASS**

# `GrayscaleColor`

```swift
public class GrayscaleColor: NSObject, NSCopying, Codable
```

> A model class representing grayscale colors. The white component can hold values between 0.0 and 255.0 while the alphavalue has a maximum value of 100.0.

## Methods
### `init(white:alpha:)`

```swift
public init(white: CGFloat, alpha: CGFloat)
```

> Creates a GrayscaleColor instance.
>
> - Parameter:
> - white: The white component.
> - alpha: The opacity component.

### `copy(with:)`

```swift
public func copy(with _: NSZone? = nil) -> Any
```

> Creates a copy of the GrayscaleColor instance.
>
> - Returns: A copy of the GrayscaleColor instance.

### `isEqual(_:)`

```swift
public override func isEqual(_ object: Any?) -> Bool
```

> Compares two GrayscaleColor instances with each other.
>
> - Parameter object: The GrayscaleColor to compare with.
>
> - Returns: 'true' if the instance is equal to the other GrayscaleColor instance, otherwise 'false''.

#### Parameters

| Name | Description |
| ---- | ----------- |
| object | The GrayscaleColor to compare with. |
14 changes: 11 additions & 3 deletions Documentation/Reference/enums/SheetyColorsType.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ public enum SheetyColorsType: Equatable, CaseIterable
> An enum used for specifying the color model of the SheetyColors view.

## Cases
### `rgb`
### `grayscale`

```swift
case rgb
case grayscale
```

> The RGB color model.
> The grayscale color model.

### `hsb`

Expand All @@ -24,3 +24,11 @@ case hsb
```

> The HSB color model.

### `rgb`

```swift
case rgb
```

> The RGB color model.
12 changes: 12 additions & 0 deletions Documentation/Reference/extensions/GrayscaleColor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**EXTENSION**

# `GrayscaleColor`

## Properties
### `uiColor`

```swift
public var uiColor: UIColor
```

> The UIColor representation of the GrayscaleColor.
8 changes: 8 additions & 0 deletions Documentation/Reference/extensions/UIColor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
# `UIColor`

## Properties
### `grayscaleColor`

```swift
var grayscaleColor: GrayscaleColor
```

> The GrayscaleColor representation of the UIColor instance.
### `hsbaColor`

```swift
Expand Down

0 comments on commit b619faf

Please sign in to comment.