Документация autumn-collections + аннотации ОСени

.vitepress/config.mts

@@ -74,6 +74,7 @@ export default defineConfig({
           { text: 'autumn', link: '/getting-started/about-autumn' },
           { text: 'winow', link: '/winow/' },
           { text: 'annotations', link: '/annotations/' },
+          { text: 'autumn-collections', link: '/autumn-collections/' },
         ]
        },
       { 
@@ -102,6 +103,13 @@ export default defineConfig({
         ],
         collapsed: false,
       }),
+      "/autumn-collections/": getSidebar({
+        contentRoot: contentRoot + 'products/autumn-collections/',
+        contentDirs: [
+          { text: 'autumn-collections', dir: '.' }
+        ],
+        collapsed: false,
+      }),
       "/winow/": getSidebar({
         contentRoot: contentRoot + 'products/winow/',
         contentDirs: [
@@ -124,6 +132,13 @@ export default defineConfig({
         ],
         collapsed: false,
       }),
+      "/api/autumn-collections": getSidebar({
+        contentRoot,
+        contentDirs: [
+          { text: 'autumn-collections', dir: 'api/autumn-collections' }
+        ],
+        collapsed: false,
+      }),
 
     },
 

docs/api/autumn-collections/Аннотации/ПрилепляемаяКоллекция.md

@@ -0,0 +1,9 @@
+# АннотацияПрилепляемаяКоллекция
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта(Значение) 
+```
+

docs/api/autumn-collections/Классы/УправляющийПрилепляемымиКоллекциями.md

@@ -0,0 +1,30 @@
+# УправляющийПрилепляемымиКоллекциями
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+## ДобавитьПрилепляемуюКоллекцию
+
+```bsl
+
+Процедура ДобавитьПрилепляемуюКоллекцию(Тип) Экспорт
+```
+
+## ПолучитьПрилепляемуюКоллекцию
+
+```bsl
+
+Функция ПолучитьПрилепляемуюКоллекцию(Имя) Экспорт
+```
+
+## ЕстьПрилепляемаяКоллекция
+
+```bsl
+
+Функция ЕстьПрилепляемаяКоллекция(Имя) Экспорт
+```
+

docs/api/autumn-collections/Прилепляемые-коллекции/Карта.md

@@ -0,0 +1,23 @@
+# ПрилепляемаяКоллекцияКарта
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+## Добавить
+
+```bsl
+
+Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
+```
+
+## Получить
+
+```bsl
+
+Функция Получить() Экспорт
+```
+

docs/api/autumn-collections/Прилепляемые-коллекции/Массив.md

@@ -0,0 +1,23 @@
+# ПрилепляемаяКоллекцияМассив
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+## Добавить
+
+```bsl
+
+Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
+```
+
+## Получить
+
+```bsl
+
+Функция Получить() Экспорт
+```
+

docs/api/autumn-collections/Прилепляемые-коллекции/Множество.md

@@ -0,0 +1,23 @@
+# ПрилепляемаяКоллекцияМножество
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+## Добавить
+
+```bsl
+
+Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
+```
+
+## Получить
+
+```bsl
+
+Функция Получить() Экспорт
+```
+

docs/api/autumn-collections/Прилепляемые-коллекции/Соответствие.md

@@ -0,0 +1,23 @@
+# ПрилепляемаяКоллекцияСоответствие
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+## Добавить
+
+```bsl
+
+Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
+```
+
+## Получить
+
+```bsl
+
+Функция Получить() Экспорт
+```
+

docs/api/autumn-collections/Прилепляемые-коллекции/Список.md

@@ -0,0 +1,23 @@
+# ПрилепляемаяКоллекцияСписок
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+## Добавить
+
+```bsl
+
+Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
+```
+
+## Получить
+
+```bsl
+
+Функция Получить() Экспорт
+```
+

docs/api/autumn-collections/Прилепляемые-коллекции/ТаблицаЗначений.md

@@ -0,0 +1,23 @@
+# ПрилепляемаяКоллекцияТаблицаЗначений
+
+## ПриСозданииОбъекта
+
+```bsl
+
+Процедура ПриСозданииОбъекта() 
+```
+
+## Добавить
+
+```bsl
+
+Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
+```
+
+## Получить
+
+```bsl
+
+Функция Получить() Экспорт
+```
+

docs/api/autumn/Аннотации/Блестяшка.md

@@ -0,0 +1,23 @@
+# АннотацияБлестяшка
+
+## ПриСозданииОбъекта
+
+```bsl
+// Маркерная аннотация для указания, что прилепляемая частица
+// является произвольным значением, передаваемым в конструктор желудя.
+//
+// Может быть использована только над параметром конструктора/метода завязи желудя.
+//
+// Пример:
+//
+// 1.
+// &Желудь
+// Процедура ПриСозданииОбъекта(&Блестяшка ПроизвольноеЗначение)
+//
+// 2.
+// &Завязь
+// Функция МойЖелудь(&Блестяшка ПроизвольноеЗначение) Экспорт
+//
+Процедура ПриСозданииОбъекта() 
+```
+

docs/api/autumn/Аннотации/Верховный.md

@@ -0,0 +1,31 @@
+# АннотацияВерховный
+
+## ПриСозданииОбъекта
+
+```bsl
+// Помечает желудь как имеющий приоритет среди других желудей с таким же именем или `&Прозвищем`.
+// В случае конфликта имен при получении желудей или их регистрации, будет использован желудь с аннотацией `&Верховный`.
+//
+// При наличии нескольких желудей с одним и тем же прозвищем позволяет определить, какой из них следует возвращать
+// при поиске конкретного желудя по его прозвищу.
+//
+// Если несколько желудей с одним и тем же именем/прозвищем имеют аннотацию `&Верховный`, будет вызвано исключение.
+//
+// Размещается над определением желудя - конструктором или методом &Завязи.
+//
+// Пример:
+// 1.
+// &Верховный
+// &Желудь("ПереопределяемыйЖелудь")
+// Процедура ПриСозданииОбъекта()
+// КонецПроцедуры
+// .
+// 2.
+// &Верховный
+// &Завязь
+// Функция ПереопределяемыйЖелудь() Экспорт
+// КонецФункции
+//
+Процедура ПриСозданииОбъекта() 
+```
+

docs/api/autumn/Аннотации/Деталька.md

@@ -0,0 +1,43 @@
+# АннотацияДеталька
+
+## ПриСозданииОбъекта
+
+```bsl
+// Маркерная аннотация для указания, что прилепляемая частица
+// является настройкой приложения.
+//
+// Может быть использована над параметром конструктора/метода завязи желудя, полем класса
+// или методом установки значения.
+//
+// Параметры:
+//   Значение - Строка - Ключ настройки. См. библиотеку [configor](https://github.com/oscript-library/configor)
+//                       для полного описания синтаксиса.
+//                       Если не заполнено, используется имя параметра конструктора/поля класса
+//                       или часть имени метода для установки значения.
+//   ЗначениеПоУмолчанию - Произвольный - Значение, которое принимает деталька, если не задано из-вне. 
+//
+// Пример:
+//
+//  1.
+//  &Деталька
+//  Перем ПутьКФайлу;
+//
+//  2.
+//  &Деталька(Значение = "Настройки.ПутьКФайлу", ЗначениеПоУмолчанию = "./file.txt")
+//  Перем ПутьКФайлу;
+//
+//  3.
+//  &Желудь
+//  Процедура ПриСозданииОбъекта(&Деталька ПутьКФайлу)
+//
+//  4.
+//  &Деталька
+//  Процедура УстановитьПутьКФайлу(Значение) Экспорт
+//
+//  5.
+//  &Завязь
+//  Функция МойЖелудь(&Деталька ПутьКФайлу) Экспорт
+//
+Процедура ПриСозданииОбъекта(Значение = "", ЗначениеПоУмолчанию = Неопределено) 
+```
+

docs/api/autumn/Аннотации/Дуб.md

@@ -0,0 +1,30 @@
+# АннотацияДуб
+
+## ПриСозданииОбъекта
+
+```bsl
+// Помечает указанный класс как фабрику компонентов - дуб, из которого появляются желуди.
+// `&Дуб` сам по себе тоже является желудем, то есть может запрашивать прилепление частиц,
+// является объектом для обработки `&Напильник`ом, может иметь `&Спецификация` и так далее.
+//
+// Дуб обычно содержит методы, помеченные аннотацией `&Завязь`, которые возвращают желуди, но
+// может содержать и другие методы, не связанные непосредственно с созданием желудей.
+//
+// Размещается над конструктором класса.
+//
+// Параметры:
+//   Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
+//                       как оно возвращается функцией `ТипЗнч`.
+// Пример:
+// &Дуб
+// Процедура ПриСозданииОбъекта()
+// КонецПроцедуры
+// .
+// &Завязь
+// Функция ПользовательскийЖелудь() Экспорт
+// .   Возврат Новый ПользовательскийЖелудь();
+// КонецФункции
+//
+Процедура ПриСозданииОбъекта(Значение = "") 
+```
+

docs/api/autumn/Аннотации/Желудь.md

@@ -0,0 +1,21 @@
+# АннотацияЖелудь
+
+## ПриСозданииОбъекта
+
+```bsl
+// Помечает указанный класс как желудь - компонент, жизненным циклом которого управляет фреймворк ОСень.
+//
+// Размещается над конструктором класса.
+//
+// Параметры:
+//   Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
+//                       как оно возвращается функцией `ТипЗнч`.
+//
+// Пример:
+// &Желудь
+// Процедура ПриСозданииОбъекта()
+// КонецПроцедуры
+//
+Процедура ПриСозданииОбъекта(Значение = "") 
+```
+