style: Изменение документирующих комментариев

src/ExternalDataProcessors/cURL/ObjectModule.bsl

@@ -33,7 +33,7 @@
 // Получает содержимое по URL.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 // 
 // Возвращаемое значение:
 //  см. ЭтотОбъект
@@ -44,43 +44,43 @@
 // Получает содержимое по URL и возвращает в текстовом формате.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 // 
 // Возвращаемое значение:
-//  Строка - Содержимое по URL в текстовом формате
+//  Строка - Полученное содержимое по URL в текстовом формате
 Функция GetString(URL) Экспорт
 	Возврат Get(URL).ОтветКакТекст();
 КонецФункции
 
 // Получает содержимое по URL и возвращает в формате JSON.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 // 
 // Возвращаемое значение:
-//  Произвольный - Содержимое по URL и возвращает в формате JSON
+//  Произвольный - Полученное содержимое по URL в формате JSON
 Функция GetJson(URL) Экспорт
 	Возврат Get(URL).ОтветКакJson();
 КонецФункции
 
 // Получает содержимое по URL и возвращает в формате двоичных данных.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 // 
 // Возвращаемое значение:
-//  ДвоичныеДанные, Неопределено - Содержимое по URL в формате двоичных данных
+//  ДвоичныеДанные, Неопределено - Полученное содержимое по URL в формате двоичных данных
 Функция GetBinaryData(URL) Экспорт
 	Возврат Get(URL).ОтветКакДвоичныеДанные();
 КонецФункции
 
 // Скачивает файл по URL.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 // 
 // Возвращаемое значение:
-//  Строка, Неопределено - Путь к файлу
+//  Строка, Неопределено - Путь к загруженному файлу
 //@skip-check bsl-legacy-check-method-names-are-unique
 Функция GetFile(URL) Экспорт
 	Возврат Get(URL).ОтветКакПутьФайлу();
@@ -90,7 +90,7 @@
 // Для HTTP(S) будет использован метод PUT.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 //  Файл - Строка - путь к файлу, адрес двоичных данных во временном хранилище
 //       - ДвоичныеДанные
 //       - Файл
@@ -104,7 +104,7 @@
 // (HTTP) Отправляет POST запрос.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 //  Данные - Строка - Простой текст, путь к файлу, адрес двоичных данных во временном хранилище 
 //         - Структура
 //         - Соответствие из КлючИЗначение
@@ -121,7 +121,7 @@
 // (HTTP) Отправляет PUT запрос.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 //  Данные - Строка - Простой текст, путь к файлу, адрес двоичных данных во временном хранилище 
 //         - Структура
 //         - Соответствие из КлючИЗначение
@@ -225,7 +225,7 @@
 
 КонецФункции
 
-// Аутентификация по логину и паролю.
+// Устанавливает аутентификацию по логину и паролю.
 // 
 // Параметры:
 //  ИмяПользователя - Строка - Имя пользователя
@@ -240,7 +240,7 @@
 	Возврат ЭтотОбъект();
 КонецФункции
 
-// (HTTP) Digest-аутентификация.
+// (HTTP) Устанавливает Digest-аутентификацию.
 // 
 // Параметры:
 //  ИмяПользователя - Строка - Имя пользователя
@@ -255,7 +255,7 @@
 	Возврат ЭтотОбъект();
 КонецФункции
 
-// (HTTP) AWS V4 Signature аутентификация.
+// (HTTP) Устанавливает AWS V4 Signature аутентификацию.
 // 
 // Параметры:
 //  КлючДоступа - Строка - Ключ доступа
@@ -317,13 +317,13 @@
 
 КонецФункции
 
-// (HTTP) Возвращает значение заголовка запроса.
+// (HTTP) Возвращает значение HTTP заголовка запроса.
 // 
 // Параметры:
 //  Имя - Строка - Имя заголовка запроса
 // 
 // Возвращаемое значение:
-//  Строка - Значение заголовка запроса
+//  Строка - Значение HTTP заголовка запроса
 Функция Заголовок(Имя) Экспорт
 	ИмяИсходное = ИменаЗаголовковЗапросаВНижнемРегистре.Получить(НРег(Имя)); // Строка
 
@@ -339,29 +339,29 @@
 	Возврат Значение;	
 КонецФункции
 
-// (HTTP) Возвращает значение заголовка ответа.
+// (HTTP) Возвращает значение HTTP заголовка ответа.
 // 
 // Параметры:
 //  Имя - Строка - Имя заголовка ответа
 // 
 // Возвращаемое значение:
-//  Строка, Массив из Строка, Неопределено - Значение заголовка ответа
+//  Строка, Массив из Строка, Неопределено - Значение HTTP заголовка ответа
 Функция ЗаголовокОтвета(Имя) Экспорт
 	Возврат ЗаголовкиОтвета.Получить(НРег(Имя));	
 КонецФункции
 
-// (HTTP) Возвращает заголовки ответа.
+// (HTTP) Возвращает HTTP заголовки ответа.
 // 
 // Возвращаемое значение:
-//  Соответствие из КлючИЗначение - Заголовки ответа:
+//  Соответствие из КлючИЗначение - HTTP заголовки ответа:
 //  	* Ключ - Строка - Имя заголовка
 //  	* Значение - Строка, Массив из Строка - Значение(я) заголовка
 Функция ЗаголовкиОтвета() Экспорт
 	//@skip-check invocation-parameter-type-intersect
 	Возврат СкопироватьСоответствие(ЗаголовкиОтвета);
 КонецФункции
 
-// (HTTP) Возвращает куки.
+// (HTTP) Возвращает куки (cookie).
 // 
 // Возвращаемое значение:
 //  Соответствие из КлючИЗначение - Куки
@@ -388,18 +388,18 @@
 
 КонецФункции
 
-// (HTTP) Возвращает куки строкой.
+// (HTTP) Возвращает куки (cookie) строкой.
 // 
 // Возвращаемое значение:
-//  Строка - Куки
+//  Строка - Пары Name=Value разделенные точкой с запятой.
 Функция КукиСтрокой() Экспорт
 	Возврат Заголовок("Cookie");
 КонецФункции
 
-// (HTTP) Устанавливает куки.
+// (HTTP) Устанавливает куки (cookie).
 // 
 // Параметры:
-//  Куки - Строка - Куки
+//  Куки - Строка - Пары Name=Value разделенные точкой с запятой.
 // 
 // Возвращаемое значение:
 //  см. ЭтотОбъект
@@ -408,7 +408,7 @@
 	Возврат ЭтотОбъект();	
 КонецФункции
 
-// (HTTP) Дополнять куки значениями Set-Cookie из заголовков ответа после выполнения запроса
+// (HTTP) Дополнять куки значениями Set-Cookie из заголовков ответа после выполнения запроса.
 // 
 // Параметры:
 //  Обновлять - Булево - Обновлять
@@ -420,7 +420,7 @@
 	Возврат ЭтотОбъект();
 КонецФункции
 
-// (HTTP) Дополнить куки значениями Set-Cookie из заголовков ответа
+// (HTTP) Дополнить куки значениями Set-Cookie из заголовков ответа.
 Процедура ОбновитьКуки() Экспорт
 
 	Если Не ЭтоHTTP() Тогда
@@ -471,7 +471,7 @@
 // (HTTP) Возвращает куки полученные из заголовка ответа Set-Cookie строкой.
 // 
 // Возвращаемое значение:
-//  Строка - Куки из ответа строкой
+//  Строка - Пары Name=Value разделенные точкой с запятой.
 Функция КукиИзОтветаСтрокой() Экспорт
 
 	КукиСтрокой = "";
@@ -491,7 +491,7 @@
 // 
 // Параметры:
 //  ПеренаправлятьЗапрос - Булево - Перенаправлять запрос
-//  ОтправлятьДанныеАутентификацииНаДругойХост - Булево - Отправляет данные аутентификации 
+//  ОтправлятьДанныеАутентификацииНаДругойХост - Булево - Отправлять данные аутентификации 
 //  	при перенаправлении на другой хост
 // 
 // Возвращаемое значение:
@@ -522,8 +522,9 @@
 	Возврат КодСостояния;
 КонецФункции
 
-// Устанавливает сертификат клиента. Если сертификат не содержит закрытый ключ,
-// то необходимо его указать вызвав метод см. УстановитьЗакрытыйКлючСертификата
+// Устанавливает сертификат клиента. 
+// Если сертификат не содержит закрытый ключ, то его можно указать вызвав 
+// метод см. УстановитьЗакрытыйКлючСертификата
 // 
 // Параметры:
 //  ИмяФайла - Строка - Имя файла сертификата клиента
@@ -632,10 +633,10 @@
 	Возврат ЭтотОбъект();
 КонецФункции
 
-// Установить исполняемый файл cURL.
+// Использует исполняемый файл cURL для выполнения команд.
 // 
 // Параметры:
-//  Путь - Строка - Путь
+//  Путь - Строка - Путь к исполняемому файлу
 // 
 // Возвращаемое значение:
 //  см. ЭтотОбъект
@@ -682,8 +683,8 @@
 // Собирает консольную команду curl.
 // 
 // Параметры:
-//  URL - Строка - URL
-//  Метод - Строка - Метод (GET, POST, PUT и т.д.)
+//  URL - Строка - Адрес ресурса в сети Интернет
+//  Метод - Строка - Метод запроса (GET, POST, PUT и т.д.)
 //  Данные - Строка - Простой текст, путь к файлу, адрес двоичных данных во временном хранилище
 //         - Структура
 //         - Соответствие из КлючИЗначение
@@ -740,14 +741,14 @@
 // 
 // Возвращаемое значение:
 //  см. ЭтотОбъект
-Функция УстановитьПрокси(Протокол, Хост, Порт) Экспорт
+Функция УстановитьПрокси(Протокол, Хост, Порт = 1080) Экспорт
 	Прокси.Протокол = Протокол;
 	Прокси.Хост = Хост;
 	Прокси.Порт = Порт;
 	Возврат ЭтотОбъект();
 КонецФункции
 
-// Аутентификация по логину и паролю для прокси-сервера.
+// Устанавливает аутентификацию по логину и паролю для прокси-сервера.
 // 
 // Параметры:
 //  ИмяПользователя - Строка - Имя пользователя
@@ -764,7 +765,7 @@
 	Возврат ЭтотОбъект();
 КонецФункции
 
-// (HTTP) Digest-аутентификация для прокси-сервера.
+// (HTTP) Устанавливает Digest-аутентификацию для прокси-сервера.
 // 
 // Параметры:
 //  ИмяПользователя - Строка - Имя пользователя
@@ -782,8 +783,8 @@
 КонецФункции
 
 // Устанавливает сертификат клиента для прокси-сервера. 
-// Если сертификат не содержит закрытый ключ, то необходимо его указать вызвав 
-// метод см. УстановитьЗакрытыйКлючСертификата
+// Если сертификат не содержит закрытый ключ, то его можно указать вызвав 
+// метод см. ПроксиУстановитьЗакрытыйКлючСертификата
 // 
 // Параметры:
 //  ИмяФайла - Строка - Имя файла сертификата клиента
@@ -871,8 +872,8 @@
 // Отправляет запрос.
 // 
 // Параметры:
-//  URL - Строка - URL
-//  Метод - Строка - Метод
+//  URL - Строка - Адрес ресурса в сети Интернет
+//  Метод - Строка - Метод запроса
 //  Данные - Строка - Простой текст, путь к файлу, адрес двоичных данных во временном хранилище
 //         - Структура
 //         - Соответствие из КлючИЗначение
@@ -1229,7 +1230,7 @@
 // Возвращает схему URL.
 // 
 // Параметры:
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 // 
 // Возвращаемое значение:
 //  Строка - схема URL
@@ -1464,7 +1465,7 @@
 // 
 // Параметры:
 //  Опции - Соответствие из КлючИЗначение - Опции команды curl
-//  URL - Строка - URL
+//  URL - Строка - Адрес ресурса в сети Интернет
 Процедура ДобавитьОпциюURL(Опции, URL)
 	ДобавитьОпциюВСписок(Опции, "--url", URL);	
 КонецПроцедуры