Dokumentation etwas überarbeitet, einige Fehler gefixt und besser formuliert.

1 files changed, 14 insertions, 5 deletions

diff --git a/doc/csv.md b/doc/csv.md
index ccbeba8..acfa330 100644
--- a/doc/csv.md
+++ b/doc/csv.md
@@ -1,3 +1,4 @@
+
 # csv - CSV-Dateien parsen
 
 - [x] korrekt
@@ -40,7 +41,7 @@ for ( size_t nf; (nf = csv_read(&csv, in)) != 0; ) {  /* eine Zeile aus `in` les
 ~~~
 
 Es sind nur zwei Funktionen notwendig, um die Daten des FILE-Streams `in` vollständig zu verarbeiten:
-`csv_read()` liest eine Zeile aus dem Parameter `in` und liefert die Anzahl der erfolgreich geparsten Felder oder **`EOF`** bei Dateiende.
+`csv_read()` liest eine Zeile aus dem Parameter `in` und liefert die Anzahl der erfolgreich geparsten Felder oder **0** bei Dateiende.
 `csv_field()` liefert einen (read only) `const char`-Zeiger für das i-te Feld.
 
 Der Speicher für das CSV-Objekt wird automatisch von `csv_read()` beim ersten Aufruf alloziert und wieder freigeben nachdem der Stream `in` vollständig gelesen wurde.
@@ -102,7 +103,7 @@ while ( csv_read(&csv, in) ) {
 csv_cleanup(&csv);
 ~~~
 
-Dieser Code erzeugt ein neues `csv_t`-Objekt im Speicher welches anschließend mit `csv_init()` mit Standardwerten initialisiert wird.
+Dieser Code erzeugt ein neues `csv_t`-Objekt im Speicher welches anschließend durch `csv_init()` mit Standardwerten initialisiert wird.
 
 Dann wird der Datenstrom `in` zeilenweise in den Speicher eingelesen und innerhalb der Schleife verarbeitet. Die Anzahl der Felder pro Zeile wird mit Hilfe der Funktion `csv_nfields()` ermittelt. Alternativ liefert auch der Returnwert von `csv_read()` die Feldanzahl:
 
@@ -110,15 +111,16 @@ Dann wird der Datenstrom `in` zeilenweise in den Speicher eingelesen und innerha
 // ...
 size_t nf;
 while ( (nf = csv_read(&csv, in)) != 0 ) { 
+        assert(csv_nfiedls(&csv) == nf);
         // ...
 }
 // ...
 ~~~
 
-Der Rückgabewert 0 bei einem Aufruf von `csv_read()` kennzeichnet das Ende des Datenstroms.
+Der Rückgabewert **0** bei einem Aufruf von `csv_read()` kennzeichnet das Ende des Datenstroms.
 
 > **Hinweis:**  
-> Das Ende einer CSV-Datei mit 0-gelesenen Feldern zu kennzeichnen ist vollkommen legitim. Eine "leere" Zeile innerhalb der Datei würde nämlich als genau ein (leeres) Feld interpretiert, so dass der Rückgabewert hier 1 wäre. Anders gesagt: Es gibt in CSV-Dateien keine Zeilen mit 0 Feldern.
+> Das Ende einer CSV-Datei mit 0-gelesenen Feldern zu kennzeichnen ist vollkommen legitim. Eine "leere" Zeile innerhalb der Datei würde nämlich als genau ein (leeres) Feld interpretiert, so dass der Rückgabewert hier **1** wäre. Anders gesagt: Es gibt in CSV-Dateien keine Zeilen mit 0 Feldern.
 
 Der Aufruf von `csv_cleanup()` ist nicht zwingend notwendig, da alle belegten Ressourcen beim letzten `csv_read()` automatisch freigegeben werden, wenn es keinen Fehler bei der Dateiverarbeitung gab.
 
@@ -137,11 +139,14 @@ csv_t csv;
 csv_init_opt(&csv, &csv_options);
 ~~~
 
-Damit wir nicht alle Felder in `csv_options` ändern müssen, initialisieren wir dieses zunächst mit `csv_default_options` und passen dann `field_delimiter` und `field_separator` an. Das `csv`-Objekt wird nun mit der Funktion `csv_init_opt()` initialisiert, die einen zusätzlichen Zeiger auf ein `csv_options_t`-Objekt erwartet. 
+Damit wir nicht alle Felder in `csv_options` ändern müssen, initialisieren wir dieses zunächst mit `csv_default_options` und passen dann `field_delimiter` und `field_separator` für unsere Bedürfnisse an. Das `csv`-Objekt wird nun mit der Funktion `csv_init_opt()` initialisiert, die einen zusätzlichen Zeiger auf ein `csv_options_t`-Objekt erwartet. 
 
 > **Hinweis:**  
 > `csv_init(&csv);` ist letztlich nur eine kürzere Schreibweise für `csv_init_opt(&csv, &csv_default_options);`.
 
+> **Hinweis:**  
+> Die Standardwerte für Feldtrenner und Feldbegrenzer lassen sich als Übersetzungsoptionen beim Compilieren über die Makros `CSV_DEFAULT_SEPARATOR` und `CSV_DEFAULT_DELIMITER` setzen. 
+
 Der Rest der Schleife bleibt gleich.
 
 **3\. Fehlerbehandlung hinzufügen**
@@ -354,6 +359,10 @@ Anschließend wird die Datei `csv-german.o` statt `csv.o` zum Projekt dazugelink
 
 Die Headerdatei (`csv.h`) bleibt unverändert.
 
+### Speicherallokierer
+
+TODO!
+
 ## Lizenz
 
 In den letzten Jahrzehnten habe ich massiv vom Internet und seinen Inhalten profitiert. Ein gutes Stück meiner Kenntnisse und Fähigkeiten verdanke ich den vielen Foren, Webseiten, Newsgroups und Individuen die Informationen und Software kostenfrei und allgemein zugänglich bereitstellen.