From 6f928f06626fc2fa7c2096e4ea2be84e21a729ce Mon Sep 17 00:00:00 2001
From: Jagepard <dankorot@gmail.com>
Date: Wed, 22 Mar 2023 15:53:45 +0300
Subject: [PATCH] adds comments

---
 .travis.yml            | 16 ----------------
 README.md              |  4 +---
 api.md                 | 17 +++++++++++++++++
 composer.json          |  6 ++----
 docs.md                | 16 ----------------
 src/SingletonsPool.php |  8 ++++++++
 6 files changed, 28 insertions(+), 39 deletions(-)
 delete mode 100755 .travis.yml
 create mode 100755 api.md
 delete mode 100755 docs.md

diff --git a/.travis.yml b/.travis.yml
deleted file mode 100755
index 93d3c04..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,16 +0,0 @@
-language: php
-
-# Define the php versions against we want to test our code
-php:
-    - 7.4
-
-before_script:
-    - wget http://getcomposer.org/composer.phar
-    - php composer.phar install --dev --no-interaction
-
-script:
-    - mkdir -p build/logs
-    - phpunit --coverage-clover build/logs/clover.xml
-
-after_success:
-    - bash <(curl -s https://codecov.io/bash)
diff --git a/README.md b/README.md
index 466c7b6..bdb1a38 100755
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
-[![Build Status](https://travis-ci.org/Jagepard/PhpDesignPatterns-SingletonsPool.svg?branch=master)](https://travis-ci.org/Jagepard/PhpDesignPatterns-SingletonsPool)
-[![codecov](https://codecov.io/gh/Jagepard/PhpDesignPatterns-SingletonsPool/branch/master/graph/badge.svg)](https://codecov.io/gh/Jagepard/PhpDesignPatterns-SingletonsPool)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Jagepard/PhpDesignPatterns-SingletonsPool/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Jagepard/PhpDesignPatterns-SingletonsPool/?branch=master)
 [![Code Climate](https://codeclimate.com/github/Jagepard/PhpDesignPatterns-SingletonsPool/badges/gpa.svg)](https://codeclimate.com/github/Jagepard/PhpDesignPatterns-SingletonsPool)
 [![License: MIT](https://img.shields.io/badge/license-MIT-498e7f.svg)](https://mit-license.org/)
 -----
 
-# SingletonsPool | [API](https://github.com/Jagepard/PhpDesignPatterns-SingletonsPool/blob/master/docs.md "Documentation API")
+# SingletonsPool | [API](https://github.com/Jagepard/PhpDesignPatterns-SingletonsPool/blob/master/api.md "Documentation API")
 ```php main.php``` execute in terminal
 
 ##Result:
diff --git a/api.md b/api.md
new file mode 100755
index 0000000..cc2c06c
--- /dev/null
+++ b/api.md
@@ -0,0 +1,17 @@
+## Table of contents
+- [AntiPatterns\SingletonsPool\SingletonsPool](#antipatterns_singletonspool_singletonspool)
+<hr>
+
+<a id="antipatterns_singletonspool_singletonspool"></a>
+
+### Class: AntiPatterns\SingletonsPool\SingletonsPool
+| Visibility | Function |
+|:-----------|:---------|
+|public static|<em><strong>getInstance</strong>( string $name ): self</em><br>Gets an object instance<br>Получает экземпляр объекта|
+|public|<em><strong>__construct</strong>()</em><br>|
+|public|<em><strong>__sleep</strong>()</em><br>|
+|public|<em><strong>__wakeup</strong>()</em><br>|
+|public|<em><strong>__clone</strong>()</em><br>|
+<hr>
+
+###### created with [Rudra-Documentation-Collector](#https://github.com/Jagepard/Rudra-Documentation-Collector)
diff --git a/composer.json b/composer.json
index d981d76..74e762c 100755
--- a/composer.json
+++ b/composer.json
@@ -20,10 +20,8 @@
         "skype": "jagepard.ru"
     },
     "require": {
-        "php": ">=7.4"
-    },
-    "require-dev"      : {
-        "phpunit/phpunit": "^7"
+        "php": ">=7.4",
+        "rudra/docs": "dev-master"
     },
     "autoload": {
         "psr-4": {
diff --git a/docs.md b/docs.md
deleted file mode 100755
index ff38cc0..0000000
--- a/docs.md
+++ /dev/null
@@ -1,16 +0,0 @@
-## Table of contents
-
-- [\AntiPatterns\SingletonsPool\SingletonsPool](#class-antipatternssingletonspoolsingletonspool)
-
-<hr />
-
-### Class: \AntiPatterns\SingletonsPool\SingletonsPool
-
-| Visibility | Function |
-|:-----------|:---------|
-| public | <strong>__clone()</strong> : <em>void</em> |
-| public | <strong>__construct()</strong> : <em>void</em><br /><em>SingletonsPool constructor.</em> |
-| public | <strong>__sleep()</strong> : <em>void</em> |
-| public | <strong>__wakeup()</strong> : <em>void</em> |
-| public static | <strong>getInstance(</strong><em>\string</em> <strong>$singletonName</strong>)</strong> : <em>\AntiPatterns\SingletonsPool\static</em> |
-
diff --git a/src/SingletonsPool.php b/src/SingletonsPool.php
index 1aa15e8..116174a 100755
--- a/src/SingletonsPool.php
+++ b/src/SingletonsPool.php
@@ -13,6 +13,14 @@ final class SingletonsPool
 {
     private static array $instances = [];
 
+    /**
+     * Gets an object instance
+     * --------------------------
+     * Получает экземпляр объекта
+     *
+     * @param  string $name
+     * @return self
+     */
     public static function getInstance(string $name): self
     {
         if (!array_key_exists($name, static::$instances)) {