Merge branch 'release/23.05'

LICENSE

@@ -1,8 +1,8 @@
 The MIT License (MIT)
 
 Copyright (c) 2016 Andrei Ovsiankin
-Copyright (c) 2015-2021 Valery Maximov aka theshadowco
-Copyright (c) 2017-2021 BIA Technologies, LLC
+Copyright (c) 2015-2023 Valery Maximov aka theshadowco
+Copyright (c) 2017-2023 BIA Technologies, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packagedef

@@ -4,14 +4,14 @@
 ИмяПродукта = НРег(ПараметрыСистемы_ЛокальнаяВерсия.ИмяПродукта());
 
 Описание.Имя(ИмяПродукта)
-		.ВерсияСреды("1.0.21")
+		.ВерсияСреды("1.8.3.2")
 		.Версия(ПараметрыСистемы_ЛокальнаяВерсия.ВерсияПродукта())
-		.ЗависитОт("logos", "1.2")
-		.ЗависитОт("cli", "0.9.10")
-		.ЗависитОт("tempfiles", "0.2.2")
-		.ЗависитОт("1commands", "1.3.5")
-		.ЗависитОт("confluence", "1.1.0")
-		.ЗависитОт("bsl-parser", "21.09")
+		.ЗависитОт("logos", "1.4")
+		.ЗависитОт("cli", "0.10.0")
+		.ЗависитОт("tempfiles", "1.0.0")
+		.ЗависитОт("1commands", "1.5.0")
+		.ЗависитОт("confluence", "1.1.2")
+		.ЗависитОт("bsl-parser", "23.05")
 		.ЗависитОт("json", "1.1.1")
 		.ВключитьФайл("src")
 		.ВключитьФайл("pict")

readme.md

@@ -145,7 +145,8 @@
 - лицензии стороннего кода - BSDv3, Apache License, Freeware, etc - подробные разъяснения лицензий на исходный код продукта и его документации в том числе содержатся внутри файлов исходного кода
 
 TODO:
+
 1. Публикация документации в формате Markdown и каталога  doc, иерархия каталогов = иерархии подсистем (начиная с корневой)
 2. В каталоге doc предусмотреть обработку index.md - описание подсистемы
 3. Команда проверки исходников
-4. Проверка исходников по списку файлов
+4. Проверка исходников по списку файлов

src/Классы/ГенераторДокументации.os

@@ -257,7 +257,7 @@
 // ДокументацияКонстанты
 //
 // Параметры:
-//   МассивКонстант - Массив - Массив структур описаний констант
+//   ОписаниеКонстант - Массив - Массив структур описаний констант
 //						Имя - Имя константы
 //						Тип - Тип значения константы
 //						Описание - Описание константы
@@ -727,12 +727,6 @@
 
 	КонецЕсли;
 
-	Если ОписаниеМетода.Экспортный И НЕ ОжидаемЭкспортныйМетод Тогда
-
-		Возврат СтрШаблон("В разделе %1 находится экспортный метод '%2'", ОписаниеМетода.ИмяРаздела, ОписаниеМетода.ИмяМетода);
-
-	КонецЕсли;
-
 	Если ОписаниеМетода.ИмяРаздела = ТипыОбласти.РазделПрограммныйИнтерфейс Тогда
 
 		Возврат ПроверитьОписаниеМетодаAPI(ОписаниеМетода);
@@ -755,34 +749,6 @@
 
 	КонецЕсли;
 
-	Если ОписаниеМетода.ПараметрыМетода.Количество() Тогда
-
-		Ит = 0;
-
-		Для Каждого Параметр Из ОписаниеМетода.ПараметрыМетода Цикл
-
-			Ит = Ит + 1;
-
-			Если НЕ ЗначениеЗаполнено(Параметр.ОписаниеПараметра) Тогда
-
-				Ошибки.Добавить(СтрШаблон("У метода '%1' не заполнено описание параметра №%2 (%3)", ОписаниеМетода.ИмяМетода, Ит, Параметр.Имя));
-
-			КонецЕсли;
-
-		КонецЦикла;
-
-	КонецЕсли;
-
-	Если ОписаниеМетода.ТипБлока = ТипыБлоковМодуля.ЗаголовокФункции Тогда
-
-		Если НЕ ЗначениеЗаполнено(ОписаниеМетода.ОписаниеВозвращаемогоЗначения) Тогда
-
-			Ошибки.Добавить(СтрШаблон("У метода '%1' не заполнено описание возвращаемого значения", ОписаниеМетода.ИмяМетода));
-
-		КонецЕсли;
-
-	КонецЕсли;
-
 	Возврат СтрСоединить(Ошибки, Символы.ПС);
 
 КонецФункции
@@ -797,7 +763,6 @@
 	Описание.Вставить("ИмяМетода", Блок.ОписаниеБлока.ИмяМетода);
 	Описание.Вставить("Описание", Блок.ОписаниеБлока.Назначение);
 	Описание.Вставить("ПараметрыМетода", Блок.ОписаниеБлока.ПараметрыМетода);
-	Описание.Вставить("ОписаниеВозвращаемогоЗначения", Блок.ОписаниеБлока.ОписаниеВозвращаемогоЗначения);
 	Описание.Вставить("ТипВозвращаемогоЗначения", Блок.ОписаниеБлока.ТипВозвращаемогоЗначения);
 	Описание.Вставить("Примеры", Блок.ОписаниеБлока.Примеры);
 

src/Классы/ГенераторДокументации_JSON.os

@@ -82,8 +82,7 @@
 
 		Если ЭтоФункция Тогда
 			ОписаниеВозврат = Новый Структура;
-			ОписаниеВозврат.Вставить("type", ОписаниеМетода.ТипВозвращаемогоЗначения);
-			ОписаниеВозврат.Вставить("description", ОписаниеМетода.ОписаниеВозвращаемогоЗначения);
+			ОписаниеВозврат.Вставить("types", ОписаниеМетода.ТипВозвращаемогоЗначения);
 			Метод.Вставить("return", ОписаниеВозврат);
 		КонецЕсли;
 

src/Классы/ГенераторДокументации_markdown.os

@@ -113,7 +113,7 @@
 
 		Попытка
 
-			ПутьКСтранице = ОбъединитьПути(Каталог, НоваяСтраница.Имя) + ".markdown ";
+			ПутьКСтранице = ОбъединитьПути(Каталог, НоваяСтраница.Имя) + ".md";
 			ОбщегоНазначения.ЗаписатьФайл(ПутьКСтранице, СокрЛП(НоваяСтраница.Содержимое));
 
 		Исключение

src/Команды/СгенерироватьДокументацию.os

@@ -17,7 +17,8 @@
 						.Перечисление("confluence", "confluence", "Документация в формате confluence")
 						.Перечисление("html", "html", "Документация в формате html")
 						.Перечисление("json", "JSON", "Документация в формате JSON")
-						.Перечисление("markdown", "Markdown", "Документация в формате Markdown");
+						.Перечисление("markdown", "Markdown", "Документация в формате Markdown")
+						;
 
 	КомандаПриложения.Опция("config c", "",
 						"Путь к конфигурационному файлу. По умолчанию ищет в каталоге исходных файлов");
@@ -28,7 +29,7 @@
 	КомандаПриложения.Опция("errno e", Ложь,
 						"Выполняет генерацию даже при наличии ошибок");
 
-						КомандаПриложения.Опция("edt", Ложь,
+	КомандаПриложения.Опция("edt", Ложь,
 						"Исходники хранятся в формате EDT");
 
 	КомандаПриложения.Опция("push-manual", ,

src/Модули/ПараметрыПриложения.os

@@ -47,7 +47,7 @@
 //
 Функция ВерсияПродукта() Экспорт
 
-	Возврат "21.09";
+	Возврат "23.05";
 
 КонецФункции // ВерсияПродукта
 

src/Модули/ПомощникГенерацииДокументации.os

@@ -173,10 +173,13 @@
 		КонецЕсли;
 
 		Если ОписаниеМетода.ТипБлока = ТипыБлоковМодуля.ЗаголовокФункции Тогда
-
-			ЧастиТекста.Добавить(СтрШаблон(Шаблоны.ШаблонВозврат,
-				ОписаниеМетода.ТипВозвращаемогоЗначения,
-				ОбработатьСтроку(ОписаниеМетода.ОписаниеВозвращаемогоЗначения, СимволыЗамены)));
+			Для Каждого ОписаниеВозврата Из ОписаниеМетода.ТипВозвращаемогоЗначения Цикл
+				ЧастиТекста.Добавить(
+					СтрШаблон(Шаблоны.ШаблонВозврат,
+					ОписаниеВозврата.ТипПараметра,
+					ОбработатьСтроку(ОписаниеВозврата.ОписаниеПараметра, СимволыЗамены))
+				);
+			КонецЦикла; 
 
 		КонецЕсли;
 
@@ -214,11 +217,17 @@
 			СтрокиОписания.Добавить(Шаблоны.ШаблонШапкаТЧДляКонстант);
 
 			Для Каждого Константа Из ДанныеПодсистемы.Значение Цикл
-
+				Если Константа.Описание.Свойство("ru") Тогда
+					Описание = Константа.Описание.ru;
+				ИначеЕсли Константа.Описание.Свойство("en") Тогда
+					Описание = Константа.Описание.en;
+				Иначе
+					Описание = Константа.Имя;
+				КонецЕсли;
 				СтрокиОписания.Добавить(СтрШаблон(Шаблоны.ШаблонСтрокаТЧДляКонстант,
 											Константа.Имя,
 											Константа.Тип,
-											ОбработатьСтроку(Константа.Описание, СимволыЗамены)));
+											ОбработатьСтроку(Описание, СимволыЗамены)));
 
 			КонецЦикла;