From 1b9e9cdf20a29d7851e08f3326ad7808b94e09bf Mon Sep 17 00:00:00 2001
From: ulrich
Date: Thu, 14 Nov 2024 10:24:17 +0000
Subject: [PATCH] Dokumentation in Arbeit: kleinere Anpassungen

---
 src/de/uhilger/fm/Duplicator.java |   19 +++++++++++++++++--
 1 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/src/de/uhilger/fm/Duplicator.java b/src/de/uhilger/fm/Duplicator.java
index 71a6e8b..d882a02 100644
--- a/src/de/uhilger/fm/Duplicator.java
+++ b/src/de/uhilger/fm/Duplicator.java
@@ -1,5 +1,5 @@
 /*
-  neon-fm - File management extensions to Neon
+  fm - File management class library
   Copyright (C) 2024  Ulrich Hilger
 
   This program is free software: you can redistribute it and/or modify
@@ -22,12 +22,27 @@
 import java.nio.file.Files;
 
 /**
- *
+ * Eine Datei duplizieren
+ * 
  * @author Ulrich Hilger
  * @version 0.1, 08.11.2024
  */
 public class Duplicator {
   
+  /**
+   * Eine Datei duplizieren. Es entsteht eine neue Datei mit Namen 
+   * [Dateiname]-Kopie.[Endung], d.h. eine Datei namens datei.txt 
+   * wird dupliziert in datei-Kopie.txt
+   * 
+   * Wenn die Zieldatei bereits existiert, wird der neuen Datei eine 
+   * laufende Nummer angehaengt, d.h. aus datei.txt wird datei-Kopie-1.txt, 
+   * wenn datei-Kopie.txt bereits existiert.
+   * 
+   * @param base  der absolute Basispfad
+   * @param relPfad relative Pfad nebst Name der zu duplizierenden Datei
+   * @return  Name des erstellten Duplikats
+   * @throws IOException  wenn etwas schief geht
+   */
   public String duplizieren(String base, String relPfad) throws IOException {
     File srcFile = new File(base, relPfad);
     String fnameext = srcFile.getName();

--
Gitblit v1.9.3