Add api documentations (#2)

Author: cable8mm

.gitignore

@@ -90,3 +90,6 @@ $RECYCLE.BIN/
 # End of https://www.toptal.com/developers/gitignore/api/composer,macos,windows,visualstudiocode
 
 composer.lock
+/build
+/cache
+/doctum.php

README.md

@@ -1,14 +1,16 @@
 # Array Flatten
 
-[![Tests](https://github.com/cable8mm/array-flatten/actions/workflows/tests.yml/badge.svg)](https://github.com/cable8mm/array-flatten/actions/workflows/tests.yml)
-[![PHP Linting (Pint)](https://github.com/cable8mm/array-flatten/actions/workflows/coding-style-php.yml/badge.svg)](https://github.com/cable8mm/array-flatten/actions/workflows/coding-style-php.yml)
-[![Latest Stable Version](http://poser.pugx.org/cable8mm/array-flatten/v)](https://packagist.org/packages/cable8mm/array-flatten)
-[![Total Downloads](http://poser.pugx.org/cable8mm/array-flatten/downloads)](https://packagist.org/packages/cable8mm/array-flatten)
-[![release date](https://img.shields.io/github/release-date/cable8mm/array-flatten)](https://github.com/cable8mm/array-flatten/releases)
-![GitHub License](https://img.shields.io/github/license/cable8mm/array-flatten)
-[![PHP Version Require](http://poser.pugx.org/cable8mm/array-flatten/require/php)](https://packagist.org/packages/cable8mm/array-flatten)
-
-> Flatten nested arrays.
+[![code-style](https://github.com/cable8mm/array-flatten/actions/workflows/code-style.yml/badge.svg)](https://github.com/cable8mm/array-flatten/actions/workflows/code-style.yml)
+[![run-tests](https://github.com/cable8mm/array-flatten/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cable8mm/array-flatten/actions/workflows/run-tests.yml)
+![Packagist Version](https://img.shields.io/packagist/v/cable8mm/array-flatten)
+![Packagist Downloads](https://img.shields.io/packagist/dt/cable8mm/array-flatten)
+![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/cable8mm/array-flatten/php)
+![Packagist Stars](https://img.shields.io/packagist/stars/cable8mm/array-flatten)
+![Packagist License](https://img.shields.io/packagist/l/cable8mm/array-flatten)
+
+Flatten nested arrays.
+
+We have provided the API Documentation on the web. For more information, please visit https://www.palgle.com/array-flatten/ ❤️
 
 ## Installation
 

composer.json

@@ -30,12 +30,10 @@
  "laravel/pint": "^1.0"
  },
  "scripts": {
- "test": [
- "./vendor/bin/phpunit"
- ],
- "lint": [
- "./vendor/bin/pint"
- ]
+ "test": "./vendor/bin/phpunit tests",
+ "lint": "./vendor/bin/pint",
+ "inspect": "./vendor/bin/pint --test",
+ "apidoc": "doctum.phar update doctum.php --output-format=github --no-ansi --no-progress"
  },
  "minimum-stability": "stable",
  "prefer-stable": true

phpunit.xml

@@ -1,23 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
- bootstrap="vendor/autoload.php"
- cacheDirectory=".phpunit.cache"
- executionOrder="depends,defects"
- beStrictAboutCoverageMetadata="true"
- beStrictAboutOutputDuringTests="true"
- failOnRisky="true"
- failOnWarning="true"
- cacheResult ="false">
+ xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+ bootstrap="vendor/autoload.php"
+ colors="true"
+ testdox="true">
  <testsuites>
  <testsuite name="default">
  <directory>tests</directory>
  </testsuite>
  </testsuites>
 
- <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+ <source>
  <include>
  <directory>src</directory>
  </include>
  </source>
-</phpunit>
+</phpunit>

src/array_flatten.php

@@ -2,6 +2,15 @@
 
 namespace Cable8mm\ArrayFlatten;
 
+/**
+ * Flatten nested arrays. * array_flatten([1, [2, [3, [4, [5], 6], 7], 8], 9]); //=> [1, 2, 3, 4, 5, 6, 7, 8, 9]
+ *
+ * @param array $array The nested arrays
+ * @return array The array to flatten
+ *
+ * @example array_flatten([1, [2, [3, [4, [5], 6], 7], 8], 9]);
+ * //=> [1, 2, 3, 4, 5, 6, 7, 8, 9]
+ */
 function array_flatten(array $array): array
 {
  $return = [];
@@ -13,7 +22,16 @@ function array_flatten(array $array): array
  return array_raw_unique($return);
 }
 
-function array_raw_unique(array $array)
+/**
+ * Extend array_unique() to include null and space values. array_raw_unique([1, 2, 2, null, null, '', '', 9]); //=> [1, 2, null, '', '', 9]
+ *
+ * @param array $array The array
+ * @return array The unique array even if it contains null and space values
+ *
+ * @example array_raw_unique([1, 2, 2, null, null, '', '', 9]);
+ * //=> [1, 2, null, '', '', 9]
+ */
+function array_raw_unique(array $array): array
 {
  $out = [];