Skip to content

Commit

Permalink
feat: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gtokman committed Apr 24, 2021
1 parent 06e1412 commit d4ad3c1
Show file tree
Hide file tree
Showing 37 changed files with 1,742 additions and 7 deletions.
39 changes: 39 additions & 0 deletions Documentation/Reference/ExtensionKit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Reference Documentation

## Enums

- [UIImage.ArrowDirection](enums/UIImage.ArrowDirection.md)
- [UIView.GradientLayerChangingDirection](enums/UIView.GradientLayerChangingDirection.md)

## Extensions

- [Array](extensions/Array.md)
- [CFRunLoopTimer](extensions/CFRunLoopTimer.md)
- [CGPoint](extensions/CGPoint.md)
- [CGRect](extensions/CGRect.md)
- [Data](extensions/Data.md)
- [Date](extensions/Date.md)
- [FileManager](extensions/FileManager.md)
- [Int](extensions/Int.md)
- [NSObject](extensions/NSObject.md)
- [String](extensions/String.md)
- [Timer](extensions/Timer.md)
- [UIApplication](extensions/UIApplication.md)
- [UIButton](extensions/UIButton.md)
- [UIColor](extensions/UIColor.md)
- [UIImage](extensions/UIImage.md)
- [UITableView](extensions/UITableView.md)
- [UIView](extensions/UIView.md)
- [UIViewController](extensions/UIViewController.md)
- [View](extensions/View.md)

## Methods

- [+(____)](methods/+(____).md)
- [-(____)](methods/-(____).md)
- [_(____)](methods/_(____).md)
- [_(____)](methods/_(____).md)
- [dprint(__)](methods/dprint(__).md)
- [sleep(duration_)](methods/sleep(duration_).md)

This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2021-04-24 17:16:56 +0000
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**ENUM**

# `UIImage.ArrowDirection`

```swift
enum ArrowDirection
```

## Cases
### `up`

```swift
case up
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**ENUM**

# `UIView.GradientLayerChangingDirection`

```swift
enum GradientLayerChangingDirection
```

## Cases
### `top`

```swift
case top
```
33 changes: 33 additions & 0 deletions Documentation/Reference/ExtensionKit/extensions/Array.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
**EXTENSION**

# `Array`
```swift
public extension Array where Element: Equatable
```

## Properties
### `removingRepeatElements`

```swift
var removingRepeatElements: Array<Element>
```

Returns an array where repeating elements of the receiver got removed.

## Methods
### `remove(_:)`

```swift
mutating func remove(_ element: Element) -> Element?
```

Removes the given element in the array.

- Parameter element: The element to be removed.
- Returns: The element got removed, or `nil` if the element doesn't exist.

#### Parameters

| Name | Description |
| ---- | ----------- |
| element | The element to be removed. |
15 changes: 15 additions & 0 deletions Documentation/Reference/ExtensionKit/extensions/CFRunLoopTimer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**EXTENSION**

# `CFRunLoopTimer`
```swift
public extension CFRunLoopTimer
```

## Methods
### `invalidate()`

```swift
func invalidate()
```

Invalidate CFRunLoopTimer
26 changes: 26 additions & 0 deletions Documentation/Reference/ExtensionKit/extensions/CGPoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
**EXTENSION**

# `CGPoint`
```swift
public extension CGPoint
```

## Methods
### `offseted(x:y:)`

```swift
func offseted(x: CGFloat = 0.0, y: CGFloat = 0.0) -> CGPoint
```

Offset point by new x and y
- Parameters:
- x: x
- y: y
- Returns: new point

#### Parameters

| Name | Description |
| ---- | ----------- |
| x | x |
| y | y |
81 changes: 81 additions & 0 deletions Documentation/Reference/ExtensionKit/extensions/CGRect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
**EXTENSION**

# `CGRect`
```swift
public extension CGRect
```

## Properties
### `topLeft`

```swift
var topLeft: CGPoint
```

### `topRight`

```swift
var topRight: CGPoint
```

### `topMiddle`

```swift
var topMiddle: CGPoint
```

### `bottomLeft`

```swift
var bottomLeft: CGPoint
```

### `bottomRight`

```swift
var bottomRight: CGPoint
```

### `bottomMiddle`

```swift
var bottomMiddle: CGPoint
```

### `leftMiddle`

```swift
var leftMiddle: CGPoint
```

### `rightMiddle`

```swift
var rightMiddle: CGPoint
```

### `midX`

```swift
var midX: CGFloat
```

### `midY`

```swift
var midY: CGFloat
```

### `center`

```swift
var center: CGPoint
```

Center taking size into account

### `sameCenterSquare`

```swift
var sameCenterSquare: CGRect
```
15 changes: 15 additions & 0 deletions Documentation/Reference/ExtensionKit/extensions/Data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**EXTENSION**

# `Data`
```swift
public extension Data
```

## Properties
### `hexString`

```swift
var hexString: String
```

Returns a string of hex value.
15 changes: 15 additions & 0 deletions Documentation/Reference/ExtensionKit/extensions/Date.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**EXTENSION**

# `Date`
```swift
public extension Date
```

## Properties
### `day`

```swift
var day: String
```

Current day of the week in Gregorian calendar
58 changes: 58 additions & 0 deletions Documentation/Reference/ExtensionKit/extensions/FileManager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
**EXTENSION**

# `FileManager`
```swift
public extension FileManager
```

## Methods
### `fileSize(atPath:)`

```swift
func fileSize(atPath path: String) -> Int
```

Size of file at path

- Parameter path: file path
- Returns: Size in bytes

#### Parameters

| Name | Description |
| ---- | ----------- |
| path | file path |

### `folderSize(atPath:)`

```swift
func folderSize(atPath path: String) -> Int
```

Size of folder

- Parameter path: folder path
- Returns: size in bytes

#### Parameters

| Name | Description |
| ---- | ----------- |
| path | folder path |

### `directorySize(at:)`

```swift
func directorySize(at URL: URL) -> Int
```

Size of directory at URL

- Parameter URL: URL
- Returns: Size in bytes

#### Parameters

| Name | Description |
| ---- | ----------- |
| URL | URL |
Loading

0 comments on commit d4ad3c1

Please sign in to comment.