From f6eea46372f4954f8e6c1032a5879de33aee4d67 Mon Sep 17 00:00:00 2001
From: Nikita Fedkin <nixel2007@gmail.com>
Date: Mon, 9 Dec 2024 23:13:20 +0100
Subject: [PATCH] docs

---
 README.md                                     |  2 +-
 docs/api/index.md                             | 13 ++++++++++
 ...21\202\320\260\321\206\320\270\321\217.md" |  6 ++---
 ...21\202\320\260\321\206\320\270\320\271.md" | 14 +++++------
 ...21\202\320\260\321\206\320\270\320\270.md" | 14 +++++------
 ...21\202\320\260\321\206\320\270\320\271.md" | 12 ++++-----
 ...21\206\320\270\321\217\320\274\320\270.md" | 25 ++++++++-----------
 docs/index.md                                 | 12 ---------
 docs/product/index.md                         | 10 ++++++++
 9 files changed, 55 insertions(+), 53 deletions(-)
 create mode 100644 docs/api/index.md
 rename "docs/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md" => "docs/api/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md" (80%)
 rename "docs/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md" => "docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md" (87%)
 rename "docs/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md" => "docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md" (94%)
 rename "docs/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md" => "docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md" (88%)
 rename "docs/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md" => "docs/api/\320\234\320\276\320\264\321\203\320\273\320\270/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md" (93%)
 delete mode 100644 docs/index.md
 create mode 100644 docs/product/index.md

diff --git a/README.md b/README.md
index a18f1fa..7afd3ea 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 Библиотека для работы с аннотациями как с объектами первого класса. Позволяет описывать параметры аннотаций и их значения, а также получать их в виде объектов. Поддерживает механизм мета-аннотаций (аннотаций-агрегаторов других аннотаций).
 
-Публичный интерфейс библиотеки описан в каталоге [docs](./docs/index.md).
+Публичный интерфейс библиотеки описан в каталоге [docs](./docs/api/index.md).
 
 ### Примеры использования
 
diff --git a/docs/api/index.md b/docs/api/index.md
new file mode 100644
index 0000000..b9a64cc
--- /dev/null
+++ b/docs/api/index.md
@@ -0,0 +1,13 @@
+# Публичный интерфейс библиотеки `annotations`
+
+## Аннотации
+
+* [Аннотация](Аннотации/Аннотация)
+
+## Классы
+* [КонтейнерАннотаций](Классы/КонтейнерАннотаций)
+* [ОпределениеАннотации](Классы/ОпределениеАннотации)
+* [РазворачивательАннотаций](Классы/РазворачивательАннотаций)
+
+## Модули
+* [РаботаСАннотациями](Модули/РаботаСАннотациями)
diff --git "a/docs/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md" "b/docs/api/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md"
similarity index 80%
rename from "docs/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md"
rename to "docs/api/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md"
index 6375868..ee9d037 100644
--- "a/docs/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md"
+++ "b/docs/api/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270/\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217.md"
@@ -1,8 +1,6 @@
-## АннотацияАннотация
+# АннотацияАннотация
 
-* [Назад](./index.md)
-
-### ПриСозданииОбъекта
+## ПриСозданииОбъекта
 
 ```bsl
 // Базовый объект аннотации.
diff --git "a/docs/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md" "b/docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
similarity index 87%
rename from "docs/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
rename to "docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
index adb1176..80dd811 100644
--- "a/docs/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
+++ "b/docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\232\320\276\320\275\321\202\320\265\320\271\320\275\320\265\321\200\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
@@ -1,8 +1,6 @@
-## КонтейнерАннотаций
+# КонтейнерАннотаций
 
-* [Назад](./index.md)
-
-### ПриСозданииОбъекта
+## ПриСозданииОбъекта
 
 ```bsl
 // Контейнер аннотаций - объект, который хранит все определения аннотаций.
@@ -11,7 +9,7 @@
 Процедура ПриСозданииОбъекта() 
 ```
 
-### ПолучитьОпределенияАннотаций
+## ПолучитьОпределенияАннотаций
 
 ```bsl
 // Получить все определения аннотаций.
@@ -24,7 +22,7 @@
 Функция ПолучитьОпределенияАннотаций() Экспорт
 ```
 
-### ПолучитьОпределениеАннотации
+## ПолучитьОпределениеАннотации
 
 ```bsl
 // Получить определение аннотации по её имени.
@@ -39,7 +37,7 @@
 Функция ПолучитьОпределениеАннотации(Имя) Экспорт
 ```
 
-### ПолучитьРазворачивательАннотаций
+## ПолучитьРазворачивательАннотаций
 
 ```bsl
 // Получить настроенный разворачиватель аннотаций.
@@ -50,7 +48,7 @@
 Функция ПолучитьРазворачивательАннотаций() Экспорт
 ```
 
-### ДобавитьАннотацию
+## ДобавитьАннотацию
 
 ```bsl
 // Добавить аннотацию в контейнер аннотаций.
diff --git "a/docs/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md" "b/docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md"
similarity index 94%
rename from "docs/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md"
rename to "docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md"
index 7871c2a..ac566a3 100644
--- "a/docs/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md"
+++ "b/docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\236\320\277\321\200\320\265\320\264\320\265\320\273\320\265\320\275\320\270\320\265\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\270.md"
@@ -1,7 +1,5 @@
 ## ОпределениеАннотации
 
-* [Назад](./index.md)
-
 ### ПриСозданииОбъекта
 
 ```bsl
@@ -17,7 +15,7 @@
 //  Возвращаемое значение:
 //   Строка
 //
-Функция Имя() 
+Функция Имя() Экспорт
 ```
 
 ### ИмяТипаАннотации
@@ -28,7 +26,7 @@
 //  Возвращаемое значение:
 //   Строка
 //
-Функция ИмяТипаАннотации() 
+Функция ИмяТипаАннотации() Экспорт
 ```
 
 ### Параметры
@@ -50,7 +48,7 @@
 //           *** Значение - Строка - Значение параметра аннотации.
 //     * Экспорт                 - Булево          - Признак экспорта параметра.
 //
-Функция Параметры() 
+Функция Параметры() Экспорт
 ```
 
 ### Аннотации
@@ -66,7 +64,7 @@
 //       ** Имя      - Строка - Имя параметра аннотации.
 //       ** Значение - Строка - Значение параметра аннотации.
 //
-Функция Аннотации() 
+Функция Аннотации() Экспорт
 ```
 
 ### Проверить
@@ -87,7 +85,7 @@
 //       ** Значение - Строка - Значение параметра аннотации.
 //   ИмяТипаСАннотацией - Строка - Имя типа, к которому применяется аннотация.
 //
-Процедура Проверить(Аннотация, ИмяТипаСАннотацией) 
+Процедура Проверить(Аннотация, ИмяТипаСАннотацией) Экспорт
 ```
 
 ### СоздатьОбъектАннотации
@@ -105,6 +103,6 @@
 // Возвращаемое значение:
 //   Произвольный - Объект аннотации с заданными параметрами.
 //
-Функция СоздатьОбъектАннотации(Аннотация) 
+Функция СоздатьОбъектАннотации(Аннотация) Экспорт
 ```
 
diff --git "a/docs/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md" "b/docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
similarity index 88%
rename from "docs/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
rename to "docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
index af53426..6c7b385 100644
--- "a/docs/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
+++ "b/docs/api/\320\232\320\273\320\260\321\201\321\201\321\213/\320\240\320\260\320\267\320\262\320\276\321\200\320\260\321\207\320\270\320\262\320\260\321\202\320\265\320\273\321\214\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\320\271.md"
@@ -1,15 +1,13 @@
-## РазворачивательАннотаций
+# РазворачивательАннотаций
 
-* [Назад](./index.md)
-
-### ПриСозданииОбъекта
+## ПриСозданииОбъекта
 
 ```bsl
 
 Процедура ПриСозданииОбъекта(КонтейнерАннотаций) 
 ```
 
-### РазвернутьАннотацииСвойства
+## РазвернутьАннотацииСвойства
 
 ```bsl
 // Развернуть все аннотации переданного свойства рекурсивно.
@@ -17,6 +15,7 @@
 //
 // Параметры:
 //   Свойство - Структура - Описание свойства, метода или параметра метода:
+//     * Имя - Строка - Имя свойства.
 //     * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
 //       ** Имя - Строка - Имя аннотации.
 //        ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
@@ -27,7 +26,7 @@
 Процедура РазвернутьАннотацииСвойства(Свойство, ТипВладельцаСвойства) Экспорт
 ```
 
-### РазвернутьАннотацииСвойств
+## РазвернутьАннотацииСвойств
 
 ```bsl
 // Развернуть все аннотации переданного свойства рекурсивно.
@@ -35,6 +34,7 @@
 //
 // Параметры:
 //   Свойства - Массив Из Структура - Описания свойств, методов или параметров метода:
+//     * Имя - Строка - Имя свойства.
 //     * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
 //       ** Имя - Строка - Имя аннотации.
 //        ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
diff --git "a/docs/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md" "b/docs/api/\320\234\320\276\320\264\321\203\320\273\320\270/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md"
similarity index 93%
rename from "docs/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md"
rename to "docs/api/\320\234\320\276\320\264\321\203\320\273\320\270/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md"
index 066c039..e8edb13 100644
--- "a/docs/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md"
+++ "b/docs/api/\320\234\320\276\320\264\321\203\320\273\320\270/\320\240\320\260\320\261\320\276\321\202\320\260\320\241\320\220\320\275\320\275\320\276\321\202\320\260\321\206\320\270\321\217\320\274\320\270.md"
@@ -1,8 +1,6 @@
-## РаботаСАннотациями
+# РаботаСАннотациями
 
-* [Назад](./index.md)
-
-### ПолучитьАннотации
+## ПолучитьАннотации
 
 ```bsl
 // Получить все аннотации свойства с указанным именем аннотации.
@@ -19,7 +17,7 @@
 Функция ПолучитьАннотации(Свойство, ИмяАннотации) 
 ```
 
-### ПолучитьАннотацию
+## ПолучитьАннотацию
 
 ```bsl
 // Получить первую аннотацию свойства с указанным именем аннотации.
@@ -36,7 +34,7 @@
 Функция ПолучитьАннотацию(Свойство, ИмяАннотации) 
 ```
 
-### НайтиАннотации
+## НайтиАннотации
 
 ```bsl
 // Получить все аннотации с указанным именем аннотации.
@@ -52,7 +50,7 @@
 Функция НайтиАннотации(Аннотации, ИмяАннотации) 
 ```
 
-### НайтиАннотацию
+## НайтиАннотацию
 
 ```bsl
 // Получить первую аннотацию с указанным именем аннотации.
@@ -68,7 +66,7 @@
 Функция НайтиАннотацию(Аннотации, ИмяАннотации) 
 ```
 
-### НайтиМетодыСАннотацией
+## НайтиМетодыСАннотацией
 
 ```bsl
 // Получить все методы с указанной аннотацией.
@@ -85,7 +83,7 @@
 Функция НайтиМетодыСАннотацией(Методы, ИмяАннотации) 
 ```
 
-### ПолучитьПараметрыАннотации
+## ПолучитьПараметрыАннотации
 
 ```bsl
 // Получить параметры аннотации с указанным именем параметра.
@@ -102,7 +100,7 @@
 Функция ПолучитьПараметрыАннотации(Аннотация, ИмяПараметра) 
 ```
 
-### ПолучитьПараметрАннотации
+## ПолучитьПараметрАннотации
 
 ```bsl
 // Получить параметр аннотации с указанным именем параметра.
@@ -119,7 +117,7 @@
 Функция ПолучитьПараметрАннотации(Аннотация, ИмяПараметра) 
 ```
 
-### ПолучитьЗначенияПараметровАннотации
+## ПолучитьЗначенияПараметровАннотации
 
 ```bsl
 // Получить значения параметров аннотации с указанным именем параметра.
@@ -137,7 +135,7 @@
 Функция ПолучитьЗначенияПараметровАннотации(Аннотация, ИмяПараметра) 
 ```
 
-### ПолучитьЗначениеПараметраАннотации
+## ПолучитьЗначениеПараметраАннотации
 
 ```bsl
 // Получить значение параметра аннотации с указанным именем параметра.
@@ -158,7 +156,7 @@
 Функция ПолучитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра = "Значение", ЗначениеПоУмолчанию = Неопределено, НеопределеноЭтоКорректноеЗначениеПараметра = Ложь) 
 ```
 
-### УстановитьЗначениеПараметраАннотации
+## УстановитьЗначениеПараметраАннотации
 
 ```bsl
 // Установить значение параметра аннотации с указанным именем параметра.
@@ -173,4 +171,3 @@
 //
 Процедура УстановитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра, ЗначениеПараметра) 
 ```
-
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index c20624b..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,12 +0,0 @@
-## Публичный интерфейс библиотеки
-
-### Классы
-
-* [АннотацияАннотация](АннотацияАннотация.md)
-* [КонтейнерАннотаций](КонтейнерАннотаций.md)
-* [ОпределениеАннотации](ОпределениеАннотации.md)
-* [РазворачивательАннотаций](РазворачивательАннотаций.md)
-
-### Модули
-
-* [РаботаСАннотациями](РаботаСАннотациями.md)
diff --git a/docs/product/index.md b/docs/product/index.md
new file mode 100644
index 0000000..ce38100
--- /dev/null
+++ b/docs/product/index.md
@@ -0,0 +1,10 @@
+# annotations
+
+Библиотека для работы с аннотациями как с объектами первого класса. Позволяет описывать параметры аннотаций и их значения, а также получать их в виде объектов. Поддерживает механизм мета-аннотаций (аннотаций-агрегаторов других аннотаций).
+
+Публичный интерфейс библиотеки описан в разделе [api](/api/annotations/index.md).
+
+## Примеры использования
+
+> [!TIP]
+> Добавить примеры использования. Любая помощь приветствуется.