From 0bf667eeb3e06c1dbed39ac2a0acae67f623f2a7 Mon Sep 17 00:00:00 2001 From: Ilya Bushin Date: Thu, 17 Oct 2024 21:46:58 +0300 Subject: [PATCH] docs api --- .github/workflows/deploy-documentation.yml | 3 +- .../CommonModules/СЗ_Запрос/Ext/Module.bsl | 39 +++++++++++++++++-- .../Ext/Module.bsl | 7 +++- .../Ext/Module.bsl | 16 +++++++- .../Ext/Module.bsl | 9 +++-- src/cfe/ConfigDumpInfo.xml | 8 ++-- 6 files changed, 68 insertions(+), 14 deletions(-) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index b8a23f7..0acfe4a 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -23,8 +23,9 @@ jobs: - name: Скачивание BSL-Doc run: curl -L https://github.com/alkoleft/bsldoc/releases/download/0.1.0/bsldoc-0.1.0.jar --output ./bsldoc.jar && chmod +7 ./bsldoc.jar + # -s <Имя подсистемы> - только определенную подсистему - name: Генерация описания API - run: java -jar ./bsldoc.jar ./../src/cfe ./api -f Docusaurus -s СЗ_Запрос + run: java -jar ./bsldoc.jar ./../src/cfe ./api -f Docusaurus - name: Установка NodeJS uses: actions/setup-node@v4 diff --git a/src/cfe/CommonModules/СЗ_Запрос/Ext/Module.bsl b/src/cfe/CommonModules/СЗ_Запрос/Ext/Module.bsl index 15b46b5..c958fe9 100644 --- a/src/cfe/CommonModules/СЗ_Запрос/Ext/Module.bsl +++ b/src/cfe/CommonModules/СЗ_Запрос/Ext/Module.bsl @@ -1,4 +1,18 @@  +#Область ПрограммныйИнтерфейс + +// Создает структуру нового запроса +// +// Параметры: +// ИсточникДанных - Строка - таблица для получения данных +// Первые - Число - ограничение количества выборки +// Различные - Булево - признак получения неповторяющихся значений +// Разрешенные - Булево - признак ограничения выборки с применением RLS +// +// Возвращаемое значение: +// - ОбработкаОбъект.СЗ_ПроцессорСхемЗапроса - менеджер для серверного формирования запроса +// - ФормаКлиентскогоПриложения - менеджер для клиентского формирования запроса +// Функция НовыйЗапрос(ИсточникДанных, Первые = 0, Различные = Ложь, Разрешенные = Ложь) Экспорт ПроцессорСхемЗапроса = СЗ_ПроцессорыСхемЗапросаКлиентСервер @@ -8,6 +22,12 @@ КонецФункции +// Создает структуру нового предиката +// +// Возвращаемое значение: +// - ОбработкаОбъект.СЗ_ПроцессорСхемЗапроса - менеджер для серверного формирования предиката +// - ФормаКлиентскогоПриложения - менеджер для клиентского формирования предиката +// Функция Предикат() Экспорт ПроцессорПредикатов = СЗ_ПроцессорыПредикатовКлиентСервер @@ -17,11 +37,24 @@ КонецФункции -// TODO: В модуле СЗ_ПроцессорыСхемЗапросаКлиентСерверСлужебный так же регулярно требуетс -// такая структура. Рефакторинг! +// Возвращает структуру с данными поля запроса +// +// Параметры: +// ИмяПоля - Строка - +// Источник - Строка - +// Псевдоним - Строка - +// +// Возвращаемое значение: +// Структура - +// Функция НовоеПоле(ИмяПоля, Источник, Псевдоним) Экспорт + // TODO: В модуле СЗ_ПроцессорыСхемЗапросаКлиентСерверСлужебный так же регулярно требуетс + // такая структура. Рефакторинг! + Возврат Новый Структура("ИмяПоля, Источник, Псевдоним", ИмяПоля, Источник, Псевдоним); -КонецФункции \ No newline at end of file +КонецФункции + +#КонецОбласти diff --git a/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовКлиентСервер/Ext/Module.bsl b/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовКлиентСервер/Ext/Module.bsl index 28138fa..5c4573f 100644 --- a/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовКлиентСервер/Ext/Module.bsl +++ b/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовКлиентСервер/Ext/Module.bsl @@ -1,5 +1,8 @@ -#Область ПрограммныйИнтерфейс + +#Область ПрограммныйИнтерфейс +// +// Функция НовыйПроцессорПредикатов() Экспорт #Если Клиент Тогда @@ -12,6 +15,8 @@ КонецФункции +// +// Функция Выражения() Экспорт Выражения = Новый Структура; diff --git a/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовСлужебныйКлиентСервер/Ext/Module.bsl b/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовСлужебныйКлиентСервер/Ext/Module.bsl index 41afd9e..acd9612 100644 --- a/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовСлужебныйКлиентСервер/Ext/Module.bsl +++ b/src/cfe/CommonModules/СЗ_ПроцессорыПредикатовСлужебныйКлиентСервер/Ext/Module.bsl @@ -1,5 +1,12 @@ -#Область ПрограммныйИнтерфейс + +#Область ПрограммныйИнтерфейс +// +// +// Параметры: +// Предикат - +// ИмяРеквизита - +// Процедура УстановитьИмяРеквизита(Предикат, ИмяРеквизита) Экспорт Если Предикат = Неопределено Тогда @@ -11,6 +18,13 @@ КонецПроцедуры +// +// +// Параметры: +// Предикат - +// ВидСравнения - +// Значение - +// Процедура УстановитьПредикат(Предикат, ВидСравнения, Значение) Экспорт Если Предикат = Неопределено Или ПустаяСтрока(Предикат.ИмяРеквизита) Тогда diff --git a/src/cfe/CommonModules/СЗ_ПроцессорыСхемЗапросаКлиентСервер/Ext/Module.bsl b/src/cfe/CommonModules/СЗ_ПроцессорыСхемЗапросаКлиентСервер/Ext/Module.bsl index dc01c50..3c6453b 100644 --- a/src/cfe/CommonModules/СЗ_ПроцессорыСхемЗапросаКлиентСервер/Ext/Module.bsl +++ b/src/cfe/CommonModules/СЗ_ПроцессорыСхемЗапросаКлиентСервер/Ext/Module.bsl @@ -1,4 +1,5 @@ -#Область ПрограммныйИнтерфейс + +#Область ПрограммныйИнтерфейс // Возвращает обработку с контекстом и методами наполнения контекста запроса // @@ -9,10 +10,10 @@ // Разрешенные - Булево - признак ограничения выборки с применением RLS // // Возвращаемое значение: -// ОбработкаОбъект.СЗ_ПроцессорСхемЗапроса - менеджер для серверного формирования запроса -// ФормаКлиентскогоПриложения - менеджер для клиентского формирования запросов +// - ОбработкаОбъект.СЗ_ПроцессорСхемЗапроса - менеджер для серверного формирования запроса +// - ФормаКлиентскогоПриложения - менеджер для клиентского формирования запроса // -Функция НовыйПроцессорСхемЗапроса(ИсточникДанных, Первые = 0, Различные = Ложь, Разрешенные = Ложь) Экспорт +Функция НовыйПроцессорСхемЗапроса(ИсточникДанных, Первые, Различные, Разрешенные) Экспорт #Если Клиент Тогда ПроцессорСхемЗапроса = ПолучитьФорму("Обработка.СЗ_ПроцессорСхемЗапроса.Форма.Форма"); diff --git a/src/cfe/ConfigDumpInfo.xml b/src/cfe/ConfigDumpInfo.xml index 0f18f41..34314b4 100644 --- a/src/cfe/ConfigDumpInfo.xml +++ b/src/cfe/ConfigDumpInfo.xml @@ -2,15 +2,15 @@ - + - + - + - +