docs

Author: nixel2007

README.md

@@ -2,7 +2,7 @@
 
 Библиотека для работы с аннотациями как с объектами первого класса. Позволяет описывать параметры аннотаций и их значения, а также получать их в виде объектов. Поддерживает механизм мета-аннотаций (аннотаций-агрегаторов других аннотаций).
 
-Публичный интерфейс библиотеки описан в каталоге [docs](./docs/index.md).
+Публичный интерфейс библиотеки описан в каталоге [docs](./docs/api/index.md).
 
 ### Примеры использования
 

docs/api/index.md

@@ -0,0 +1,13 @@
+# Публичный интерфейс библиотеки `annotations`
+
+## Аннотации
+
+* [Аннотация](Аннотации/Аннотация)
+
+## Классы
+* [КонтейнерАннотаций](Классы/КонтейнерАннотаций)
+* [ОпределениеАннотации](Классы/ОпределениеАннотации)
+* [РазворачивательАннотаций](Классы/РазворачивательАннотаций)
+
+## Модули
+* [РаботаСАннотациями](Модули/РаботаСАннотациями)

docs/АннотацияАннотация.md renamed to docs/api/Аннотации/Аннотация.md

@@ -1,8 +1,6 @@
-## АннотацияАннотация
+# АннотацияАннотация
 
-* [Назад](./index.md)
-
-### ПриСозданииОбъекта
+## ПриСозданииОбъекта
 
 ```bsl
 // Базовый объект аннотации.

docs/КонтейнерАннотаций.md renamed to docs/api/Классы/КонтейнерАннотаций.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
 // Добавить аннотацию в контейнер аннотаций.

docs/ОпределениеАннотации.md renamed to docs/api/Классы/ОпределениеАннотации.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 @@
 // Возвращаемое значение:
 //   Произвольный - Объект аннотации с заданными параметрами.
 //
-Функция СоздатьОбъектАннотации(Аннотация) 
+Функция СоздатьОбъектАннотации(Аннотация) Экспорт
 ```
 

docs/РазворачивательАннотаций.md renamed to docs/api/Классы/РазворачивательАннотаций.md

@@ -1,22 +1,21 @@
-## РазворачивательАннотаций
+# РазворачивательАннотаций
 
-* [Назад](./index.md)
-
-### ПриСозданииОбъекта
+## ПриСозданииОбъекта
 
 ```bsl
 
 Процедура ПриСозданииОбъекта(КонтейнерАннотаций) 
 ```
 
-### РазвернутьАннотацииСвойства
+## РазвернутьАннотацииСвойства
 
 ```bsl
 // Развернуть все аннотации переданного свойства рекурсивно.
 // Для разворачивания используются данные из определений аннотаций.
 //
 // Параметры:
 //   Свойство - Структура - Описание свойства, метода или параметра метода:
+//     * Имя - Строка - Имя свойства.
 //     * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
 //       ** Имя - Строка - Имя аннотации.
 //        ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
@@ -27,14 +26,15 @@
 Процедура РазвернутьАннотацииСвойства(Свойство, ТипВладельцаСвойства) Экспорт
 ```
 
-### РазвернутьАннотацииСвойств
+## РазвернутьАннотацииСвойств
 
 ```bsl
 // Развернуть все аннотации переданного свойства рекурсивно.
 // Для разворачивания используются данные из определений аннотаций.
 //
 // Параметры:
 //   Свойства - Массив Из Структура - Описания свойств, методов или параметров метода:
+//     * Имя - Строка - Имя свойства.
 //     * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
 //       ** Имя - Строка - Имя аннотации.
 //        ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:

docs/РаботаСАннотациями.md renamed to docs/api/Модули/РаботаСАннотациями.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 @@
 //
 Процедура УстановитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра, ЗначениеПараметра) 
 ```
-

docs/index.md

@@ -0,0 +1,10 @@
+# annotations
+
+Библиотека для работы с аннотациями как с объектами первого класса. Позволяет описывать параметры аннотаций и их значения, а также получать их в виде объектов. Поддерживает механизм мета-аннотаций (аннотаций-агрегаторов других аннотаций).
+
+Публичный интерфейс библиотеки описан в разделе [api](/api/annotations/index.md).
+
+## Примеры использования
+
+> [!TIP]
+> Добавить примеры использования. Любая помощь приветствуется.