add: comments over functions

diff --git a/discspan.c b/discspan.c
index 60fd551a138f53a78e2fd681dc4da24f14b7d5e5..88f1729e9a7a9b313dc549c3a025b8c4dddbc936 100644 (file)
--- a/discspan.c
+++ b/discspan.c
@@ -6,6 +6,9 @@
 #include <unistd.h>
 #include "file_size.h"
 
+/**
+ * Gibt die Groesse in einer lesbaren Darstellung aus
+ */
 void printHumanReadSize(const char *output, unsigned long long int splitgroesse)
 {
        unsigned long long humanread;
@@ -25,6 +28,14 @@ void printHumanReadSize(const char *output, unsigned long long int splitgroesse)
                        splitgroesse, humanread, *(einheit + i));
 }
 
+/**
+ * Vergleicht zwei Dateien mit ihrer Groesse
+ *
+ * @param filea erste Datei
+ * @param fileb zweite Datei
+ *
+ * @return integer
+ */
 int cmpfunc(const void *filea, const void *fileb)
 {
        long long unsigned int a = ((const struct file_size*)filea)->fsize;
@@ -40,6 +51,13 @@ int cmpfunc(const void *filea, const void *fileb)
                return -2;
 }
 
+/**
+ * Ermittelt die Zeilen der Textdatei
+ *
+ * @param Datei pointer
+ *
+ * @return Anzahl von Zeilen
+ */
 int get_array_length(FILE *in)
 {
        int lines = 0;
@@ -53,6 +71,15 @@ int get_array_length(FILE *in)
        return lines;
 }
 
+/**
+ * Liest die Datei in den Ram ein und gibt die Laenge des Arrays zurueck
+ *
+ * @param Datei pointer
+ * @param file_size pointer
+ * @param Splitgroesse
+ *
+ * @return Arraylaenge
+ */
 unsigned long fill_array_from_file(FILE *in, struct file_size *fs,
                const long long unsigned int split)
 {
@@ -83,6 +110,9 @@ unsigned long fill_array_from_file(FILE *in, struct file_size *fs,
        return lines;
 }
 
+/**
+ * Gibt den Hilfetext aus
+ */
 void usage()
 {
        printf("\nUsage: discspan <input> <output> <option>\n\n");
@@ -100,6 +130,18 @@ void usage()
        printf("   -f <Größe>\tOption zur Größenangabe in Bytes\n\n");
 }
 
+/**
+ * Schreibt in eine Datei die Pfade der Dateien, die auf das Medium passen. Wenn
+ * ein Rest uebrig bleibt wird das Array reallociert und die Restlange zurueck-
+ * gegeben.
+ *
+ * @param pointer auf das Array mit file_size struct
+ * @param pointer auf den string fuer den Ausgabepfad der Datei
+ * @param Splitgroesse
+ * @param maximale Laenge des neuen Arrays
+ *
+ * @return Restlaenge des neuen Arrays
+ */
 int splitter(struct file_size *input, const char *output,
                unsigned long long splitgroesse, int length)
 {
@@ -137,6 +179,14 @@ int splitter(struct file_size *input, const char *output,
        return restcount;
 }
 
+/**
+ * Hauptfunktion
+ *
+ * @param Anzahl der Argumente
+ * @param Argument Array
+ *
+ * @return Erfolgreich 0; Fehler 1
+ */
 int main(int argc, char *argv[])
 {
        const char *input = argv[1];