From 269203a48b58adecd717037777ec49552ad27c53 Mon Sep 17 00:00:00 2001
From: ulrich
Date: Wed, 13 Nov 2024 17:56:36 +0000
Subject: [PATCH] Dokumentation in Arbeit
---
src/de/uhilger/fm/package-info.java | 6 ++++++
src/de/uhilger/fm/Lister.java | 9 +++++++++
2 files changed, 15 insertions(+), 0 deletions(-)
diff --git a/src/de/uhilger/fm/Lister.java b/src/de/uhilger/fm/Lister.java
index c54f4e9..ea367a2 100644
--- a/src/de/uhilger/fm/Lister.java
+++ b/src/de/uhilger/fm/Lister.java
@@ -41,6 +41,15 @@
public static final String STR_DOT = ".";
+ /**
+ *
+ * @param fName Name und relativer Pfad des Ordners, dessen Inhalt aufgelistet werden soll
+ * @param ctxPath Kontext Pfad zur Bildung des URL, der auf die Miniaturansicht verweist
+ * (koennte evtl. im Client gebildet werden, hier dann nur Mini-Dateiname zurueckgeben)
+ * @param base Basisverzeichnis, gegen das der relative Pfad aufgeloest werden soll
+ * @return die Dateiliste als JSON String
+ * @throws IOException
+ */
public String liste(String fName, String ctxPath, String base/*, String path*/) throws IOException {
File[] files = new File(base, fName).listFiles(new ImageFileFilter());
if (files != null && files.length > 0) {
diff --git a/src/de/uhilger/fm/package-info.java b/src/de/uhilger/fm/package-info.java
index 6b333a1..666fdce 100644
--- a/src/de/uhilger/fm/package-info.java
+++ b/src/de/uhilger/fm/package-info.java
@@ -1,4 +1,10 @@
/**
* Klassen fuer das Dateimanagement.
+ *
+ *
+ * Dateiinhalt abrufen:
+ * String json = new Lister().liste(ordnerName, ctx, basisOrdner);
+ *
+ *
*/
package de.uhilger.fm;
\ No newline at end of file
--
Gitblit v1.9.3