Версия 1.0.0 - полностью документировано API

Author: artbear

README.md

@@ -2,13 +2,15 @@
 
 Позволяет удобно управлять созданием и удалением временных файлов.
 
-##Методы
+## API
 
 |Метод|Описание
 |----|----|
-|``СоздатьФайл`` | создает файл во временном каталоге системы, возвращает путь
-|``НовоеИмяФайла`` | генерирует уникальное имя, по которому можно создать временный файл
-|``СоздатьКаталог`` | создает каталог во временном каталоге системы, возвращает путь
-|``СоздатьФайл`` | создает файл во временном каталоге, возвращает путь
-|``Удалить`` | удаляет все ранее созданные файлы и каталоги
-|``УдалитьФайл`` | удаляет указанный файл
+|``НовоеИмяФайла(Расширение = "tmp")`` | генерирует уникальное имя, по которому можно создать временный файл
+|``СоздатьФайл(Расширение = "tmp")`` | создает файл во временном каталоге системы, возвращает путь
+|``СоздатьКаталог(Расширение = "tmp")`` | создает каталог во временном каталоге системы, возвращает путь
+|``Удалить()`` | удаляет все ранее созданные файлы и каталоги
+|``УдалитьФайл(Путь)`` | удаляет указанный файл/каталог. Если у файла указан файловый атрибут "только для чтения", перед удалением происходит попытка снять этот атрибут.
+|``БезопасноУдалитьФайл(Путь)`` | удаляет указанный файл полностью аналогично методу `УдалитьФайл`
+|``Файлы()`` | возвращает массив с путями ко всем временным файлам
+|``УдалитьНакопленныеВременныеФайлы(ВременныеФайлыДо)`` | удаляются все накопленные временные файлы, которые были добавлены после фиксации набора временных файлов с помощью метода `Файлы`

packagedef

@@ -1,6 +1,6 @@
 
 Описание.Имя("tempfiles")
-		.Версия("0.2.2")
+		.Версия("1.0.0")
 		.ЗависитОт("logos")
 		.ВключитьФайл("ВременныеФайлы.os")
 		.ВключитьФайл("lib.config")

ВременныеФайлы.os

@@ -15,6 +15,14 @@
 /////////////////////////////////////////////////////////////////////////
 // Программный интерфейс
 
+// генерирует уникальное имя, по которому можно создать временный файл
+//
+// Параметры:
+//   Расширение - Строка - Расширение файла. По умолчанию "tmp"
+//
+//  Возвращаемое значение:
+//   Строка - полный путь временного файла
+//
 Функция НовоеИмяФайла(Знач Расширение = "tmp") Экспорт
 
 	Если БазовыйКаталог = Неопределено Тогда
@@ -30,6 +38,14 @@
 
 КонецФункции
 
+// создает файл с расширением во временном каталоге системы
+//
+// Параметры:
+//   Расширение - Строка - Расширение файла. По умолчанию "tmp"
+//
+//  Возвращаемое значение:
+//   Строка - полный путь созданного временного файла
+//
 Функция СоздатьФайл(Знач Расширение = "tmp") Экспорт
 
 	ИмяФайла = НовоеИмяФайла(Расширение);
@@ -40,6 +56,14 @@
 
 КонецФункции
 
+// создает каталог с расширением во временном каталоге системы
+//
+// Параметры:
+//   Расширение - Строка - Расширение файла. По умолчанию "tmp"
+//
+//  Возвращаемое значение:
+//   Строка - полный путь созданного временного каталога
+//
 Функция СоздатьКаталог(Знач Расширение = "tmp") Экспорт
 
 	ИмяФайла = НовоеИмяФайла(Расширение);
@@ -49,6 +73,8 @@
 
 КонецФункции
 
+// удаляет все ранее созданные файлы и каталоги
+//
 Процедура Удалить() Экспорт
 
 	КрайнийИндекс = мВременныеФайлы.Количество()-1;
@@ -64,10 +90,28 @@
 
 КонецПроцедуры
 
+// удаляет указанный файл/каталог. 
+// Если у файла указан файловый атрибут "только для чтения", перед удалением происходит попытка снять этот атрибут.
+//
+// Параметры:
+//   Путь - Строка - путь файла
+//
+//  Возвращаемое значение:
+//   Булево - удалось или не удалось удалить файл
+//
 Функция УдалитьФайл(Знач Путь) Экспорт
 	Возврат БезопасноУдалитьФайл(Путь);
 КонецФункции
 
+// удаляет указанный файл/каталог. 
+// Если у файла указан файловый атрибут "только для чтения", перед удалением происходит попытка снять этот атрибут.
+//
+// Параметры:
+//   Путь - Строка - путь файла
+//
+//  Возвращаемое значение:
+//   Булево - удалось или не удалось удалить файл
+//
 Функция БезопасноУдалитьФайл(Знач Путь) Экспорт
 
 	Попытка