docs: Добавлена документация API

Author: Stivo182

docs/README.md

@@ -28,6 +28,10 @@
 - [Сортировка отчета](СортировкаОтчета.md) - способы сортировки итоговой таблицы.
 - [Экспорт результатов](ЭкспортРезультатов.md) - форматы экспорта и каталог артефактов.
 
+## Публичный API
+
+- [Документация API](api/README.md) - справочник публичного API пакета `benchmark`.
+
 ## Примеры
 
 - [Примеры бенчмарков](../samples/benchmarks) - готовые `.os`-файлы с примерами бенчмарков.

docs/api/README.md

@@ -0,0 +1,53 @@
+# Документация API
+
+Документация по публичному API пакета `benchmark`.
+
+## Основные точки входа
+
+- [Бенчмаркинг](Бенчмаркинг.md) - модуль для запуска бенчмарков из кода
+- [КонфигурацияБенчмарков](КонфигурацияБенчмарков.md) - программная настройка запуска, отчета, экспорта, параметров и обработчиков событий
+
+## Дескрипторы и параметры
+
+- [ДескрипторБенчмарка](ДескрипторБенчмарка.md) - описание одного метода бенчмарка
+- [КоллекцияДескрипторовБенчмарков](КоллекцияДескрипторовБенчмарков.md) - коллекция дескрипторов с поиском, фильтрацией и копированием
+- [ПараметрБенчмарка](ПараметрБенчмарка.md) - один параметр бенчмарка
+- [ПараметрыМетодаБенчмарка](ПараметрыМетодаБенчмарка.md) - коллекция параметров метода
+
+## Результаты и отчеты
+
+- [РезультатЗапускаБенчмарков](РезультатЗапускаБенчмарков.md) - результат полного запуска
+- [РезультатЗапускаКейса](РезультатЗапускаКейса.md) - результат одного кейса
+- [РезультатИтерацииКейса](РезультатИтерацииКейса.md) - замер одной итерации
+- [КейсБенчмарка](КейсБенчмарка.md) - дескриптор, параметры и runtime для запуска
+- [ЧекпоинтЗапускаБенчмарков](ЧекпоинтЗапускаБенчмарков.md) - точка продолжения изолированного запуска
+- [СтатистикаБенчмарка](СтатистикаБенчмарка.md) - расчет и конвертация статистики замеров
+- [ОтчетБенчмарков](ОтчетБенчмарков.md) - таблица итогового отчета и работа с колонками
+- [КолонкиОтчетаБенчмарков](КолонкиОтчетаБенчмарков.md) - реестр стандартных и пользовательских колонок отчета
+- [КолонкаОтчетаБенчмарков](КолонкаОтчетаБенчмарков.md) - описание одной колонки отчета
+- [ПараметрыПредставленияКолонкиОтчетаБенчмарков](ПараметрыПредставленияКолонкиОтчетаБенчмарков.md) - настройки отображения колонки
+
+## Окружение и справочники
+
+- [ИсполняющаяСредаБенчмарков](ИсполняющаяСредаБенчмарков.md) - описание версии OneScript для сравнительных запусков
+- [СредаОкруженияБенчмарков](СредаОкруженияБенчмарков.md) - сведения о версии библиотеки, ОС, runtime и процессоре
+- [ОбработчикСобытияБенчмарка](ОбработчикСобытияБенчмарка.md) - связь события жизненного цикла и метода-обработчика
+- [ЕдиницыИзмеренийБенчмарков](ЕдиницыИзмеренийБенчмарков.md) - единицы времени, памяти и производительности
+- [ЕдиницаИзмеренияБенчмарка](ЕдиницаИзмеренияБенчмарка.md) - одна единица измерения
+- [СтратегииЗапускаБенчмарка](СтратегииЗапускаБенчмарка.md) - стратегии выполнения бенчмарков
+- [СортировкиОтчетаБенчмарков](СортировкиОтчетаБенчмарков.md) - варианты сортировки отчета
+- [СобытияБенчмарков](СобытияБенчмарков.md) - события жизненного цикла запуска
+- [ЭтапыБенчмарка](ЭтапыБенчмарка.md) - этапы выполнения кейса
+- [ЭкспортерыРезультатовБенчмарков](ЭкспортерыРезультатовБенчмарков.md) - преднастроенные экспортеры результатов
+- [СтилиКоэффициентаБенчмарка](СтилиКоэффициентаБенчмарка.md) - стили отображения коэффициентов
+
+## Экспорт и сериализация
+
+- [СериализаторРезультатовБенчмарков](СериализаторРезультатовБенчмарков.md) - чтение и запись результата запуска в JSON
+- [СериализаторНастроекЗапускаБенчмарков](СериализаторНастроекЗапускаБенчмарков.md) - чтение и запись настроек запуска в JSON
+- [СериализацияОбъектовБенчмаркинга](СериализацияОбъектовБенчмаркинга.md) - низкоуровневое JSON-представление объектов бенчмаркинга
+- [НастройкиЗапускаБенчмарков](НастройкиЗапускаБенчмарков.md) - сериализуемый контейнер настроек дочернего процесса
+- [ЭкспортерРезультатовБенчмарков](ЭкспортерРезультатовБенчмарков.md) - координатор экспорта артефактов
+- [ЭкспортерРезультатовБенчмарковВMarkdown](ЭкспортерРезультатовБенчмарковВMarkdown.md) - экспорт Markdown
+- [ЭкспортерРезультатовБенчмарковВJson](ЭкспортерРезультатовБенчмарковВJson.md) - экспорт JSON
+- [ЭкспортерРезультатовБенчмарковВHtml](ЭкспортерРезультатовБенчмарковВHtml.md) - экспорт HTML

docs/api/Бенчмаркинг.md

@@ -0,0 +1,74 @@
+# Бенчмаркинг
+
+Модуль `Бенчмаркинг` - основная точка входа для запуска бенчмарков из кода.
+
+## Методы
+
+[Запустить](#запустить) </br>
+[ЗапуститьИзКаталога](#запуститьизкаталога)
+
+## Запустить
+
+**Синтаксис:**
+
+```bsl
+Запустить(<ИсточникБенчмарков>, <Конфигурация>)
+```
+
+**Параметры:**
+
+| Имя | Тип | Значение по умолчанию | Описание |
+| -- | -- | -- | -- |
+| ИсточникБенчмарков | Тип, [ДескрипторБенчмарка](ДескрипторБенчмарка.md), [КоллекцияДескрипторовБенчмарков](КоллекцияДескрипторовБенчмарков.md) |  | Источник бенчмарков для запуска |
+| Конфигурация | [КонфигурацияБенчмарков](КонфигурацияБенчмарков.md), Неопределено | `Неопределено` | Настройки запуска. Если не переданы, используется конфигурация по умолчанию |
+
+**Возвращаемое значение:**
+
+Тип: [РезультатЗапускаБенчмарков](РезультатЗапускаБенчмарков.md).
+
+**Описание:**
+
+Запускает бенчмарки в изолированном процессе, выводит результат через консольный репортер и возвращает объект результата.
+
+**Пример:**
+
+```bsl
+Конфигурация = Новый КонфигурацияБенчмарков()
+    .УстановитьКоличествоИтераций(10)
+    .ДобавитьЭкспортер(ЭкспортерыРезультатовБенчмарков.Json);
+
+Результат = Бенчмаркинг.Запустить(Тип("БенчмаркКоллекций"), Конфигурация);
+```
+
+## ЗапуститьИзКаталога
+
+**Синтаксис:**
+
+```bsl
+ЗапуститьИзКаталога(<Каталог>, <ИскатьВПодкаталогах>, <Конфигурация>)
+```
+
+**Параметры:**
+
+| Имя | Тип | Значение по умолчанию | Описание |
+| -- | -- | -- | -- |
+| Каталог | Строка |  | Путь к каталогу с файлами бенчмарков |
+| ИскатьВПодкаталогах | Булево | `Ложь` | Сканировать вложенные каталоги |
+| Конфигурация | [КонфигурацияБенчмарков](КонфигурацияБенчмарков.md), Неопределено | `Неопределено` | Конфигурация, которая объединяется с конфигурацией каждого найденного файла |
+
+**Возвращаемое значение:**
+
+Тип: `ТаблицаЗначений`.
+
+Колонки:
+
+| Имя | Тип | Описание |
+| -- | -- | -- |
+| Результат | [РезультатЗапускаБенчмарков](РезультатЗапускаБенчмарков.md), Неопределено | Результат запуска файла |
+| ИмяФайла | Строка | Имя файла бенчмарка |
+| ПолноеИмяФайла | Строка | Полный путь к файлу |
+| Успешно | Булево | Признак успешного выполнения |
+
+**Описание:**
+
+Ищет `.os`-файлы с бенчмарками в каталоге и запускает найденные сценарии. Удобно для пакетного запуска набора файлов.