From e1fae256e29eb7a317d5a810d7e24751eb6032eb Mon Sep 17 00:00:00 2001
From: ulrich
Date: Wed, 13 Nov 2024 22:45:34 +0000
Subject: [PATCH] Dokumentation in Arbeit

---
 src/de/uhilger/fm/package-info.java |   35 ++++++++++++++++++++++++++++++++++-
 1 files changed, 34 insertions(+), 1 deletions(-)

diff --git a/src/de/uhilger/fm/package-info.java b/src/de/uhilger/fm/package-info.java
index 6b333a1..291bed9 100644
--- a/src/de/uhilger/fm/package-info.java
+++ b/src/de/uhilger/fm/package-info.java
@@ -1,4 +1,37 @@
 /**
- * Klassen fuer das Dateimanagement. 
+ * Klassen fuer das Dateimanagement mit java.nio.file. 
+ * 
+ * Die folgenden Funktionen sind enthalten:
+ * 
+ * <pre>
+ * Ordnerinhalt auflisten:    
+ *    Lister().liste(ordnerName, ctx, basisOrdner)
+ * 
+ *   TODO: JSON-Liste und Miniurl sowie Handhabung von Bilddateien ueberpruefen
+ * 
+ * Datei speichern:
+ *    Writer.speichern(file, content)
+ * 
+ * Dateien und Ordner loeschen:
+ *    Eraser.deleteFiles(relPfad, dateiname, basis)
+ * 
+ * Kopieren von Dateien und Ordnern:
+ *    Mover().copyOrMoveFiles(quelle, ziel, dateiNamen, op, base)
+ * 
+ * Verschieben von Dateien und Ordnern:
+ *    Mover().copyOrMoveFiles(quelle, ziel, dateiNamen, op, base)
+ * 
+ * Duplizieren einer Datei:
+ *    Duplicator().duplizieren(base, fileName)
+ * 
+ * Umbenennen einer Datei oder eines Ordners:
+ *    Renamer().umbenennen(exchange, fileName, params[1], file)
+ * 
+ * Packen eines Ordners:
+ *    Deflator().packFolder(fileName, path, base)
+ * 
+ * Entpacken einer ZIP-Datei:
+ *    Inflator().extractZipfile(fileName, path, base)
+ * </pre>
  */
 package de.uhilger.fm;
\ No newline at end of file

--
Gitblit v1.9.3