Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nixel2007 committed Dec 9, 2024
1 parent 8d05f9e commit 1c2c761
Show file tree
Hide file tree
Showing 10 changed files with 224 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Публичный интерфейс библиотеки `autumn-collections`

## Аннотации

* [ПрилепляемаяКоллекция](Аннотации/ПрилепляемаяКоллекция)

## Классы
* [УправляющийПрилепляемымиКоллекциями](Классы/УправляющийПрилепляемымиКоллекциями)

## Прилепляемые коллекции
* [Карта](Прилепляемые-коллекции/Карта)
* [Массив](Прилепляемые-коллекции/Массив)
* [Множество](Прилепляемые-коллекции/Множество)
* [Соответствие](Прилепляемые-коллекции/Соответствие)
* [Список](Прилепляемые-коллекции/Список)
* [ТаблицаЗначений](Прилепляемые-коллекции/ТаблицаЗначений)

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# АннотацияПрилепляемаяКоллекция

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта(Значение)
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# УправляющийПрилепляемымиКоллекциями

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта()
```

## ДобавитьПрилепляемуюКоллекцию

```bsl
Процедура ДобавитьПрилепляемуюКоллекцию(Тип) Экспорт
```

## ПолучитьПрилепляемуюКоллекцию

```bsl
Функция ПолучитьПрилепляемуюКоллекцию(Имя) Экспорт
```

## ЕстьПрилепляемаяКоллекция

```bsl
Функция ЕстьПрилепляемаяКоллекция(Имя) Экспорт
```

23 changes: 23 additions & 0 deletions docs/api/Прилепляемые-коллекции/Карта.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ПрилепляемаяКоллекцияКарта

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта()
```

## Добавить

```bsl
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
```

## Получить

```bsl
Функция Получить() Экспорт
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ПрилепляемаяКоллекцияМассив

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта()
```

## Добавить

```bsl
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
```

## Получить

```bsl
Функция Получить() Экспорт
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ПрилепляемаяКоллекцияМножество

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта()
```

## Добавить

```bsl
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
```

## Получить

```bsl
Функция Получить() Экспорт
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ПрилепляемаяКоллекцияСоответствие

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта()
```

## Добавить

```bsl
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
```

## Получить

```bsl
Функция Получить() Экспорт
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ПрилепляемаяКоллекцияСписок

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта()
```

## Добавить

```bsl
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
```

## Получить

```bsl
Функция Получить() Экспорт
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# ПрилепляемаяКоллекцияТаблицаЗначений

## ПриСозданииОбъекта

```bsl
Процедура ПриСозданииОбъекта()
```

## Добавить

```bsl
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
```

## Получить

```bsl
Функция Получить() Экспорт
```

30 changes: 30 additions & 0 deletions docs/product/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# autumn-collections

Модуль реализует функциональность прилепляемых коллекций для [ОСени](https://github.com/autumn-library/autumn)

Поставляются прилепляемые коллекции для типов:
* [Массив](https://oscript.io/syntax/page/Массив)
* [Соответствие](https://oscript.io/syntax/page/Соответствие)
* [ТаблицаЗначений](https://oscript.io/syntax/page/ТаблицаЗначений)
* [Список](https://github.com/sfaqer/collectionos#список)
* [Множество](https://github.com/sfaqer/collectionos)
* [Карта](https://github.com/sfaqer/collectionos#карта)

Так же имеется возможность добавить собственную прилепляемую коллекцию, реализовав класс по примеру ниже:

```bsl
Перем Коллекция;
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт
Коллекция.Добавить(Желудь);
КонецПроцедуры
Функция Получить() Экспорт
Возврат СтрСоединить(Коллекция, ", ");
КонецФункции
&ПрилепляемаяКоллекция("Строка")
Процедура ПриСозданииОбъекта()
Коллекция = Новый Массив();
КонецПроцедуры
```

0 comments on commit 1c2c761

Please sign in to comment.