Merge pull request #73 from Jagepard/wip

Допилил комменты до требований

Merge pull request #73 from Jagepard/wip
Допилил комменты до требований
d808da5b · Korotkov Danila · GitHub · cb24b733 · 86f2c82a · d808da5b
--- a/docs.md
+++ b/docs.md
@@ -7,14 +7,13 @@
 <a id="rudra_annotation_annotation"></a>

 ### Class: Rudra\Annotation\Annotation
-##### implements [Rudra\Annotation\AnnotationInterface](#rudra_annotation_annotationinterface)
 | Visibility | Function |
 |:-----------|:---------|
-|public|<em><strong>getAnnotations</strong>( string $className  ?string $methodName ): array</em><br>|
-|public|<em><strong>getAttributes</strong>( string $className  ?string $methodName ): array</em><br>|
-|private|<em><strong>extractShortClassName</strong>( string $fullyQualifiedName ): string</em><br>|
-|private|<em><strong>getReflection</strong>( string $className  ?string $methodName ): ReflectionClass|ReflectionMethod</em><br>|
-|private|<em><strong>parseAnnotations</strong>( string $docBlock ): array</em><br>|
+| public | `getAnnotations(string $className, ?string $methodName): array`<br> |
+| public | `getAttributes(string $className, ?string $methodName): array`<br> |
+| private | `extractShortClassName(string $fullyQualifiedName): string`<br> |
+| private | `getReflection(string $className, ?string $methodName): ReflectionClass\|ReflectionMethod`<br> |
+| private | `parseAnnotations(string $docBlock): array`<br> |


 <a id="rudra_annotation_annotationinterface"></a>
@@ -22,8 +21,8 @@
 ### Class: Rudra\Annotation\AnnotationInterface
 | Visibility | Function |
 |:-----------|:---------|
-|abstract public|<em><strong>getAnnotations</strong>( string $className  ?string $methodName ): array</em><br>|
-|abstract public|<em><strong>getAttributes</strong>( string $className  ?string $methodName ): array</em><br>|
+| abstract public | `getAnnotations(string $className, ?string $methodName): array`<br> |
+| abstract public | `getAttributes(string $className, ?string $methodName): array`<br> |


 <a id="rudra_annotation_paramsextractor"></a>
@@ -31,8 +30,8 @@
 ### Class: Rudra\Annotation\ParamsExtractor
 | Visibility | Function |
 |:-----------|:---------|
-|public|<em><strong>getParams</strong>( array $exploded  string $assignment ): array</em><br>Parses an array of parameter strings into an associative array.<br>Преобразует массив строк с параметрами в ассоциативный массив.<br>from: "param1, param2 = 'param2', param3={param1;param2:'param2'}"<br>to: ["param1", "param2" => "param2", "param3" => ["param1", "param2" => "param2"]]|
-|private|<em><strong>handleData</strong>( string $data  array $exploded ): ?array</em><br>Parses data into key => value pairs<br>Преобразует данные в пары «ключ => значение»|
+| public | `getParams(array $exploded, string $assignment): array`<br>Parses an array of parameter strings into an associative array.<br>--------------------<br>Преобразует массив строк с параметрами в ассоциативный массив.<br>`from: "param1, param2 = 'param2', param3={param1;param2:'param2'}"`<br>`to: ["param1", "param2" => "param2", "param3" => ["param1", "param2" => "param2"]]` |
+| private | `handleData(string $data, array $exploded): ?array`<br>Parses data into `key => value` pairs<br>--------------------<br>Преобразует данные в пары `ключ => значение` |
 <hr>

 ###### created with [Rudra-Documentation-Collector](#https://github.com/Jagepard/Rudra-Documentation-Collector)
--- a/src/Annotation.php
+++ b/src/Annotation.php
@@ -17,7 +17,7 @@ class Annotation implements AnnotationInterface
 {
    /**
     * Parameter separator
-     * -------------------
+     * --------------------
     * Разделитель параметров
     * 
     * in the line  ',', example: key='param', key2='param2'
@@ -27,7 +27,7 @@ class Annotation implements AnnotationInterface

    /**
     * Assignment mark
-     * ---------------
+     * --------------------
     * Знак присваивания
     * 
     * in the line  '=', example: key='param'

--- a/src/ParamsExtractor.php
+++ b/src/ParamsExtractor.php
@@ -13,11 +13,11 @@ class ParamsExtractor
 {
    /**
     * Parses an array of parameter strings into an associative array.
-     * ---------------------------------------------------------------
+     * --------------------
     * Преобразует массив строк с параметрами в ассоциативный массив.
     * 
-     * from: "param1, param2 = 'param2', param3={param1;param2:'param2'}"
-     * to: ["param1", "param2" => "param2", "param3" => ["param1", "param2" => "param2"]]
+     * `from: "param1, param2 = 'param2', param3={param1;param2:'param2'}"`
+     * `to: ["param1", "param2" => "param2", "param3" => ["param1", "param2" => "param2"]]`
     * 
     * @param array $exploded
     * @param string $assignment
@@ -39,9 +39,9 @@ class ParamsExtractor


    /**
-     * Parses data into key => value pairs
-     * -----------------------------------
-     * Преобразует данные в пары «ключ => значение»
+     * Parses data into `key => value` pairs
+     * --------------------
+     * Преобразует данные в пары `ключ => значение`
     *
     * @param string $data
     * @param array $exploded
@@ -51,7 +51,7 @@ class ParamsExtractor
    {
        /**
         * If in data an array of type param3={param1;param2:'param2'}
-         * -----------------------------------------------------------
+         * --------------------
         * Если в данных есть массив типа param3={param1;param2:'param2'}
         */
        if (preg_match("/=\s*{/", $data) && preg_match("/{(.*)}/", $exploded[1], $matches)) {
@@ -65,7 +65,7 @@ class ParamsExtractor

        /**
         * Remove quotation marks around parameter
-         * ---------------------------------------
+         * --------------------
         * Удаляет кавычки вокруг параметра
         * 
         * matches[1] = 'param2';