README formatting updated

This commit is contained in:
Vladimir Makarov 2023-04-17 17:32:20 +03:00
parent 8119dd75a8
commit ace01b6cd2
1 changed files with 5 additions and 9 deletions

View File

@ -4,12 +4,12 @@
## - `TextFormatter`
Класс `TextFormatter` представляет из себя сервис, принимающий регулярное выражение на вход и предоставляющий возможность генерации следующих объектов:<br>
- `Replacement template` из `getRegexReplacement()`;<br>
- `Placeholder` из `getRegexPlaceholder()`;<br>
- `Formatter text` из `getFormattedText(_ text: String)`
Класс `TextFormatter` представляет из себя сервис, принимающий регулярное выражение на вход и предоставляющий возможность генерации следующих объектов:
\- `Replacement template` из `getRegexReplacement()`;
\- `Placeholder` из `getRegexPlaceholder()`;
\- `Formatter text` из `getFormattedText(_ text: String)`
-
#### `func getRegexReplacement()`
Метод, преобразующий входящее регулярное выражение в шаблон подстановки, например:
@ -17,7 +17,6 @@
**Input**: `(\\d{4}) ?(\\d{4}) ?(\\d{4}) ?(\\d{4})`<br>
**Output**: `$1 $2 $3 $4`
-
#### `func getRegexPlaceholder()`
Метод, преобразующий входящее регулярное выражение в текст-заполнитесь a.k.a placeholder, например:
@ -25,7 +24,6 @@
**Input**: `(\\d{4}) ?(\\d{4}) ?(\\d{4}) ?(\\d{4})`<br>
**Output**: `1234 5678 9012 3456`
-
#### `func getFormattedText(_ text: String) -> String`
Метод, преобразующий входящий текст к нужному формату, заранее определенному посредством указания регулярного выражения, например:
@ -39,7 +37,6 @@
Класс, отвечающий за генерацию `PCREGeneratorItem` из входящего регулярного выражения. Использует библиотеку `Antlr4` и `PCRE` для работы.
-
#### `static func generateReplacement(for regex: String) -> PCREGeneratorItem`
Функция, преобразующий входящее регулярное выражение в структуру, содержащую шаблон подстановки и матрицу символов, например:
@ -77,7 +74,6 @@ print(item.matrixOfSymbols)
Класс, отвечающий за генерацию текста-заполнителя a.k.a placeholder.
-
#### `static func generatePlaceholder(matrixOfSymbols: [[Character]]) -> String`
Функция, преобразующая входящую матрицу символов в текст-заполнитель, например: