Skip to content

Commit

Permalink
feat: generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ging-dev committed Dec 12, 2023
1 parent b8f9353 commit c8c920c
Show file tree
Hide file tree
Showing 9 changed files with 308 additions and 5 deletions.
9 changes: 5 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
},
"license": "MIT",
"autoload": {
"classmap": [
"src/"
]
"psr-4": {
"TikTok\\": "./src"
}
},
"authors": [
{
Expand All @@ -23,7 +23,8 @@
"minimum-stability": "stable",
"require-dev": {
"pestphp/pest": "^1.21",
"vimeo/psalm": "^5"
"vimeo/psalm": "^5",
"danog/phpdoc": "^0.1.22"
},
"config": {
"allow-plugins": {
Expand Down
33 changes: 33 additions & 0 deletions docs/TikTok/Concern/Crawlable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "TikTok\\Concern\\Crawlable: "
description: ""

---
# `TikTok\Concern\Crawlable`
[Back to index](../../index.md)

> Author: ging-dev <[email protected]>






## Method list:
* [`getBrowser(): \Symfony\Component\BrowserKit\HttpBrowser`](#getbrowser-symfony-component-browserkit-httpbrowser)

## Methods:
### `getBrowser(): \Symfony\Component\BrowserKit\HttpBrowser`




#### See also:
* `\Symfony\Component\BrowserKit\HttpBrowser`




---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
38 changes: 38 additions & 0 deletions docs/TikTok/Driver/DriverInterface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "TikTok\\Driver\\DriverInterface: "
description: ""

---
# `TikTok\Driver\DriverInterface`
[Back to index](../../index.md)

> Author: ging-dev <[email protected]>






## Method list:
* [`handle(string $url): \T`](#handle-string-url-t)

## Methods:
### `handle(string $url): \T`




Parameters:

* `$url`: `string`


#### See also:
* `\T`




---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
49 changes: 49 additions & 0 deletions docs/TikTok/Driver/FacebookDriver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: "TikTok\\Driver\\FacebookDriver: "
description: ""

---
# `TikTok\Driver\FacebookDriver`
[Back to index](../../index.md)

> Author: ging-dev <[email protected]>






## Constants
* `TikTok\Driver\FacebookDriver::CDN_URL`:


## Method list:
* [`handle(string $url): mixed`](#handle-string-url-mixed)
* [`getBrowser(): \Symfony\Component\BrowserKit\HttpBrowser`](#getbrowser-symfony-component-browserkit-httpbrowser)

## Methods:
### `handle(string $url): mixed`




Parameters:

* `$url`: `string`



### `getBrowser(): \Symfony\Component\BrowserKit\HttpBrowser`




#### See also:
* `\Symfony\Component\BrowserKit\HttpBrowser`




---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
49 changes: 49 additions & 0 deletions docs/TikTok/Driver/SnaptikDriver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: "TikTok\\Driver\\SnaptikDriver: "
description: ""

---
# `TikTok\Driver\SnaptikDriver`
[Back to index](../../index.md)

> Author: ging-dev <[email protected]>






## Constants
* `TikTok\Driver\SnaptikDriver::CDN_URL`:


## Method list:
* [`handle(string $url): mixed`](#handle-string-url-mixed)
* [`getBrowser(): \Symfony\Component\BrowserKit\HttpBrowser`](#getbrowser-symfony-component-browserkit-httpbrowser)

## Methods:
### `handle(string $url): mixed`




Parameters:

* `$url`: `string`



### `getBrowser(): \Symfony\Component\BrowserKit\HttpBrowser`




#### See also:
* `\Symfony\Component\BrowserKit\HttpBrowser`




---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
33 changes: 33 additions & 0 deletions docs/TikTok/Util/Token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "TikTok\\Util\\Token: "
description: ""

---
# `TikTok\Util\Token`
[Back to index](../../index.md)

> Author: ging-dev <[email protected]>






## Method list:
* [`extract(string $string): string|false`](#extract-string-string-string-false)

## Methods:
### `extract(string $string): string|false`




Parameters:

* `$string`: `string`



---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
74 changes: 74 additions & 0 deletions docs/TikTok/VideoDownloader.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: "TikTok\\VideoDownloader: "
description: ""

---
# `TikTok\VideoDownloader`
[Back to index](../index.md)

> Author: ging-dev <[email protected]>






## Method list:
* [`__construct(\TikTok\Driver\DriverInterface<\T> $driver)`](#__construct-tiktok-driver-driverinterface-t-driver)
* [`setDriver(\TikTok\Driver\DriverInterface<\T> $driver): \TikTok\VideoDownloader<\T>`](#setdriver-tiktok-driver-driverinterface-t-driver-tiktok-videodownloader-t)
* [`get(string $url): \T`](#get-string-url-t)

## Methods:
### `__construct(\TikTok\Driver\DriverInterface<\T> $driver)`




Parameters:

* `$driver`: `\TikTok\Driver\DriverInterface<\T>`


#### See also:
* `\T`
* [\TikTok\Driver\DriverInterface](../TikTok/Driver/DriverInterface.md)




### `setDriver(\TikTok\Driver\DriverInterface<\T> $driver): \TikTok\VideoDownloader<\T>`




Parameters:

* `$driver`: `\TikTok\Driver\DriverInterface<\T>`


#### See also:
* `\T`
* [\TikTok\Driver\DriverInterface](../TikTok/Driver/DriverInterface.md)




### `get(string $url): \T`




Parameters:

* `$url`: `string`


#### See also:
* `\T`




---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)
26 changes: 26 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
description: "Tiktok video downloader"
title: "gingteam/tiktok"

---
# `gingteam/tiktok`

Tiktok video downloader



## Abstract classes
* [\TikTok\Driver\DriverInterface](TikTok/Driver/DriverInterface.md)

## Classes
* [\TikTok\VideoDownloader](TikTok/VideoDownloader.md)
* [\TikTok\Driver\FacebookDriver](TikTok/Driver/FacebookDriver.md)
* [\TikTok\Driver\SnaptikDriver](TikTok/Driver/SnaptikDriver.md)
* [\TikTok\Util\Token](TikTok/Util/Token.md)

## Traits
* [\TikTok\Concern\Crawlable](TikTok/Concern/Crawlable.md)


---
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
2 changes: 1 addition & 1 deletion src/VideoDownloader.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public function __construct(DriverInterface $driver)
/**
* @param DriverInterface<T> $driver
*
* @return self<T>
* @return VideoDownloader<T>
*/
public function setDriver(DriverInterface $driver): self
{
Expand Down

0 comments on commit c8c920c

Please sign in to comment.