Генерация API

bia-technologies · Apr 29, 2023 · f4438ab · f4438ab
1 parent a2cd008
commit f4438ab
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml
@@ -17,6 +17,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - name: Download 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
+      - name: Generate API documentation
+        run: java -jar ./bsldoc.jar ./../exts/yaxunit ./api -f Docusaurus -s ЮТДвижок
       - uses: actions/setup-node@v3
         with:
           node-version: 18

diff --git a/exts/yaxunit/src/CommonModules/МокитоСлужебный/Module.bsl b/exts/yaxunit/src/CommonModules/МокитоСлужебный/Module.bsl
@@ -167,6 +167,17 @@
 
 КонецФункции
 
+// Описание маски параметра.
+// 
+// Параметры:
+//  ТипУсловия - Строка - см. ТипыУсловийПараметров
+//  Приоритет - Число - Приоритет маски
+// 
+// Возвращаемое значение:
+//  Структура - Описание маски параметра:
+// * МаскаСопоставленияПараметров - Булево - Признак, что это маска параметра
+// * Режим - Строка - см. ТипыУсловийПараметров
+// * Приоритет - Число - Приоритет маски, используется если значение подпадает под несколько масок, чем выше приоритет, тем лучше
 Функция ОписаниеМаскиПараметра(ТипУсловия, Приоритет) Экспорт
 
 	МаскаПараметра = Новый Структура("МаскаСопоставленияПараметров", Истина);

diff --git a/exts/yaxunit/src/CommonModules/ЮТФабрика/Module.bsl b/exts/yaxunit/src/CommonModules/ЮТФабрика/Module.bsl
@@ -42,7 +42,11 @@
 // КонтекстыВызова
 //  Возвращает перечисление возможных контекстов вызова
 // Возвращаемое значение:
-//  ФиксированнаяСтруктура - Контексты вызова
+//  ФиксированнаяСтруктура - Контексты вызова:
+//  * КлиентОбычноеПриложение - Строка
+//  * КлиентУправляемоеПриложение - Строка
+//  * Сервер - Строка
+//  * ВызовСервера - Строка
 Функция КонтекстыВызова() Экспорт
 
 	Контексты = Новый Структура();