Gesammelte Doku-Updates
Groesstenteils Formatierung, Whitespace und kleinere
Aenderungen.
Change-Id: I2a7363cb10ff5b4c5252e1e7bef62d2bff6d9ff0
diff --git a/doc/sefun/log_file b/doc/sefun/log_file
index a3f3cab..b8bfb41 100644
--- a/doc/sefun/log_file
+++ b/doc/sefun/log_file
@@ -6,24 +6,30 @@
FUNKTION
========
- int log_file(string file, string text)
- int log_file(string file, string text, int size_to_break)
+ varargs int log_file(string file, string text, int size_to_break)
ARGUMENTE
=========
- file - Name der Datei, in die geschrieben werden soll
- text - Der Text, der geschrieben werden soll
- size_to_break - Groesse, ab der ein neues File begonnen wird (optional)
+ file
+ Name der Datei, in die geschrieben werden soll
+
+ text
+ Der Text, der geschrieben werden soll
+
+ size_to_break
+ Groesse, ab der ein neues File begonnen wird (optional)
BESCHREIBUNG
============
- log_file schreibt den Text text in die Datei /log/file.
- Sollte file schon mit einem /log/ beginnen, wird kein erneutes /log/ davor
- eingefuegt.
+ log_file schreibt den Text text in die Datei /log/file. Sollte file
+ schon mit einem /log/ beginnen, wird kein erneutes /log/ davor
+ eingefuegt. Falls das Zielverzeichnis unterhalb von /log/ noch
+ nicht existiert, wird dies automatisch angelegt, sofern das rufende
+ Objekt das Logfile schreiben darf.
RUECKGABEWERT
@@ -35,11 +41,12 @@
BEMERKUNGEN
===========
- Wenn die Groesse von file vor dem Schreiben 50000 Bytes ueberschreitet,
- wird sie in file.old umbenannt. Eine schon vorhandene Datei file.old
- wird dabei geloescht. Der Text wird nach dem Umbenennen geschrieben.
- Wird 'size_to_break' angegeben und ist dies > 0, wird dieser Wert (in
- Bytes) statt der 50000 Bytes zum Rotieren des Logfiles benutzt.
+ Wenn die Groesse von file vor dem Schreiben 50000 Bytes
+ ueberschreitet, wird sie in file.old umbenannt. Eine schon
+ vorhandene Datei file.old wird dabei geloescht. Der Text wird nach
+ dem Umbenennen geschrieben. Wird 'size_to_break' angegeben und ist
+ dies > 0, wird dieser Wert (in Bytes) statt der 50000 Bytes zum
+ Rotieren des Logfiles benutzt.
BEISPIELE
@@ -56,4 +63,4 @@
write_file(E)
-29.01.2017, Zesstra
+05.09.2018, Zesstra