From 0632aa95780802309ec9af49a35d33834236561c Mon Sep 17 00:00:00 2001
From: ulrich
Date: Thu, 14 Nov 2024 11:57:01 +0000
Subject: [PATCH] Buildinfos in Readme hinzugefuegt
---
src/de/uhilger/fm/Writer.java | 27 +++++++++++++++++----------
1 files changed, 17 insertions(+), 10 deletions(-)
diff --git a/src/de/uhilger/fm/Writer.java b/src/de/uhilger/fm/Writer.java
index 1b5af4e..181951d 100644
--- a/src/de/uhilger/fm/Writer.java
+++ b/src/de/uhilger/fm/Writer.java
@@ -26,14 +26,19 @@
import java.util.logging.Logger;
/**
- * Dateien und Ordner anlegen.
- * Ggf. deren Inhalt schreiben.
+ * Dateien und Ordner anlegen sowie gegebenenfalls den Inhalt von Dateien speichern.
*
* @author Ulrich Hilger
* @version 0.1, 07.11.2024
*/
public class Writer {
+ /**
+ * Einen Ordner anlegen, wenn er noch nicht exisitert
+ *
+ * @param file der Ordner, der angelegt werden soll
+ * @return 0, wenn der Ordner angelegt wurde, -1 wenn nicht
+ */
public int newFolder(File file) {
if (!file.exists()) {
file.mkdir();
@@ -44,19 +49,21 @@
}
/**
- * Datei speichern. Eine existierende Datei gleichen Namens wird
- * zuvor geloescht (= Ueberschreiben).
+ * Datei speichern.
*
- * Wenn Aenderungen in eine schon existierende Datei gespeichert werden
+ * <p>Eine existierende Datei gleichen Namens wird
+ * zuvor geloescht (= Ueberschreiben).</p>
+ *
+ * <p>Wenn Aenderungen in eine schon existierende Datei gespeichert werden
* sollen, ist es noetig, die existierende Datei mit dem neuen Inhalt zu
- * ueberschreiben, so, wie es diese Methode ausfuehrt.
+ * ueberschreiben, so, wie es diese Methode ausfuehrt.</p>
*
- * Soll statdessen eine Datei neu erstellt werden und wird dabei also unterstellt, dass
+ * <p>Soll statdessen eine Datei neu erstellt werden und wird dabei also unterstellt, dass
* unter ihrem Namen am Ablageort noch keine Datei gleichen Namens existiert, muss
- * vor der Verwendung dieser Methode sichergestellt werden, dass es so ist.
+ * vor der Verwendung dieser Methode sichergestellt werden, dass es so ist.</p>
*
- * @param file
- * @param content
+ * @param file die Datei, in die gespeichert werden soll
+ * @param content der zu speichernde Inhalt
* @return 0, wenn erfolgreich, sonst -1
*/
public int speichern(File file, String content) {
--
Gitblit v1.9.3