Merge pull request #2 from uqs/english

Translate comments to English, thus turning these files into plain AS…
Return-To-The-Roots · Aug 9, 2015 · 9b30887 · 9b30887
2 parents 68d58d3 + 13c6248
commit 9b30887
Show file tree

Hide file tree

Showing 10 changed files with 136 additions and 200 deletions.
diff --git a/INSTALL b/INSTALL
@@ -11,9 +11,8 @@ make install
 
 -------------------------------------------------------------------------------
 
-Andere make-Ziele:
+Further make targets:
 
-make mrproper (räumt alles weg was kein Source und 
-               zur Erstellung notwendig ist)
+make mrproper (remove everything but the source code)
 
 -------------------------------------------------------------------------------
diff --git a/src/libendian.cpp b/src/libendian.cpp
@@ -25,8 +25,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 /** @namespace libendian
  *
- *  Hilfreich zum Einlesen von diversen Daten - welche in den verschiedenen
- *  Endianen vorliegen.
+ *  Useful to read various files of different endianness.
  *
  *  @author FloSoft
  */

diff --git a/src/libendian.h b/src/libendian.h
@@ -23,97 +23,67 @@
 
 #include <cstdio>
 
-/// Die verschiedenen Big und ihre entsprechenden Little-Endian-Funktionen.
+/// Various Big and Little Endian functions.
 namespace libendian
 {
-    /// Vertauscht die Bytes eines Shorts.
+    /// Swap the bytes of (unsigned) shorts and ints.
     short swap_s(short s);
-
-    /// Vertauscht die Bytes eines Unsigned Shorts.
     unsigned short swap_us(unsigned short us);
-
-    /// Vertauscht die Bytes eines Ints.
     int swap_i(int i);
-
-    /// Vertauscht die Bytes eines Unsigned Ints.
     unsigned int swap_ui(unsigned int ui);
 
 
-    /// liest Little-Endian kodierte Chars aus einer Datei.
+    /// Read LE coded (unsigned) chars from a FILE.
     int le_read_c(char* const to, unsigned int count, FILE* file);
-
-    /// liest Little-Endian kodierte Unsigned Chars aus einer Datei.
     int le_read_uc(unsigned char* const to, unsigned int count, FILE* file);
 
-    /// schreibt Little-Endian kodierte Chars aus einer Datei.
+    /// Write LE coded (unsigned) chars to a FILE.
     int le_write_c(const char* const from, unsigned int count, FILE* file);
-
-    /// schreibt Little-Endian kodierte Unsigned Chars aus einer Datei.
     int le_write_uc(const unsigned char* const from, unsigned int count, FILE* file);
 
 
-    /// liest Big-Endian kodierte Chars aus einer Datei.
+    /// Read BE coded (unsigned) chars from a FILE.
     int be_read_c(char* const to, unsigned int count, FILE* file);
-
-    /// liest Big-Endian kodierte Unsigned Chars aus einer Datei.
     int be_read_uc(unsigned char* const to, unsigned int count, FILE* file);
 
-    /// schreibt Big-Endian kodierte Chars aus einer Datei.
+    /// Write BE coded (unsigned) chars to a FILE.
     int be_write_c(const char* const from, unsigned int count, FILE* file);
-
-    /// schreibt Big-Endian kodierte Unsigned Chars aus einer Datei.
     int be_write_uc(const unsigned char* const from, unsigned int count, FILE* file);
 
 
-    /// liest einen Little-Endian kodierten Integer aus einer Datei.
+    /// Read an LE coded (unsigned) int from a FILE.
     int le_read_i(int* to, FILE* file);
-
-    /// liest einen Little-Endian kodierten Unsigned Integer aus einer Datei.
     int le_read_ui(unsigned int* to, FILE* file);
 
-    /// schreibt einen Little-Endian kodierten Integer in eine Datei.
+    /// Write an LE coded (unsigned) int to a FILE.
     int le_write_i(int from, FILE* file);
-
-    /// schreibt einen Little-Endian kodierten Unsigned Integer in eine Datei.
     int le_write_ui(unsigned int from, FILE* file);
 
 
-    /// liest einen Big-Endian kodierten Integer aus einer Datei.
+    /// Read a BE coded (unsigned) int from a FILE.
     int be_read_i(int* to, FILE* file);
-
-    /// liest einen Big-Endian kodierten Unsigned Integer aus einer Datei.
     int be_read_ui(unsigned int* to, FILE* file);
 
-    /// schreibt einen Big-Endian kodierten Integer in eine Datei.
+    /// Write a BE coded (unsigned) int to a FILE.
     int be_write_i(int to, FILE* file);
-
-    /// schreibt einen Big-Endian kodierten Unsigned Integer in eine Datei.
     int be_write_ui(unsigned int to, FILE* file);
 
 
-    /// liest einen Little-Endian kodierten Short aus einer Datei.
+    /// Read an LE coded (unsigned) short from a FILE.
     int le_read_s(short* to, FILE* file);
-
-    /// liest einen Little-Endian kodierten Unsigned Short aus einer Datei.
     int le_read_us(unsigned short* to, FILE* file);
 
-    /// schreibt einen Little-Endian kodierten Short in eine Datei.
+    /// Write an LE coded (unsigned) short to a FILE.
     int le_write_s(short from, FILE* file);
-
-    /// schreibt einen Little-Endian kodierten Unsigned Short in eine Datei.
     int le_write_us(unsigned short from, FILE* file);
 
 
-    /// liest einen Big-Endian kodierten Short aus einer Datei.
+    /// Read a BE coded (unsigned) short from a FILE.
     int be_read_s(short* to, FILE* file);
-
-    /// liest einen Big-Endian kodierten Unsigned Short aus einer Datei.
     int be_read_us(unsigned short* to, FILE* file);
 
-    /// schreibt einen Big-Endian kodierten Short in eine Datei.
+    /// Write a BE coded (unsigned) short to a FILE.
     int be_write_s(short from, FILE* file);
-
-    /// schreibt einen Big-Endian kodierten Unsigned Short in eine Datei.
     int be_write_us(unsigned short from, FILE* file);
 }
 

diff --git a/src/read_char.cpp b/src/read_char.cpp
@@ -24,13 +24,13 @@
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest Little-Endian kodierte Chars aus einer Datei.
+ *  Reads Little-Endian encoded chars from a FILE.
  *
- *  @param[out] to    Zielpuffer
- *  @param[in]  count Anzahl gewünschter Zeichen
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    target buffer
+ *  @param[in]  count number of symbols to read
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Anzahl der gelesenen Bytes, -1 bei Fehler, 0 bei EOF
+ *  @return number of read bytes, -1 on error, 0 on EOF
  *
  *  @author FloSoft
  */
@@ -41,13 +41,13 @@ int libendian::le_read_c(char* const to, unsigned int count, FILE* file)
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest Little-Endian kodierte Unsigned Chars aus einer Datei.
+ *  Reads Little-Endian encoded unsigned chars from a FILE.
  *
- *  @param[out] to    Zielpuffer
- *  @param[in]  count Anzahl gewünschter Zeichen
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    target buffer
+ *  @param[in]  count number of symbols to read
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Anzahl der gelesenen Bytes, -1 bei Fehler, 0 bei EOF
+ *  @return number of read bytes, -1 on error, 0 on EOF
  *
  *  @author FloSoft
  */
@@ -56,19 +56,19 @@ int libendian::le_read_uc(unsigned char* const to, unsigned int count, FILE* fil
     if(to == NULL || file == NULL)
         return -1;
 
-    // chars können wir ohne Konvertierung einlesen
+    // no need to convert chars
     return (int)fread(to, 1, count, file);
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest Big-Endian kodierte Chars aus einer Datei.
+ *  Reads Big-Endian encoded chars from a FILE.
  *
- *  @param[out] to    Pointer auf Zielchar(s)
- *  @param[in]  count Anzahl gewünschter Zeichen
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    pointer to target buffer
+ *  @param[in]  count number of symbols to read
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Anzahl der gelesenen Bytes, -1 bei Fehler, 0 bei EOF
+ *  @return number of read bytes, -1 on error, 0 on EOF
  *
  *  @author FloSoft
  */
@@ -79,13 +79,13 @@ int libendian::be_read_c(char* const to, unsigned int count, FILE* file)
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest Big-Endian kodierte Unsigned Chars aus einer Datei.
+ *  Reads Big-Endian encoded unsigned chars from a FILE.
  *
- *  @param[out] to    Pointer auf Zielchar(s)
- *  @param[in]  count Anzahl gewünschter Zeichen
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    pointer to target buffer
+ *  @param[in]  count number of symbols to read
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Anzahl der gelesenen Bytes, -1 bei Fehler, 0 bei EOF
+ *  @return number of read bytes, -1 on error, 0 on EOF
  *
  *  @author FloSoft
  */
@@ -94,6 +94,6 @@ int libendian::be_read_uc(unsigned char* const to, unsigned int count, FILE* fil
     if(to == NULL || file == NULL)
         return -1;
 
-    // chars können wir ohne Konvertierung einlesen
+    // no need to convert chars
     return (int)fread(to, 1, count, file);
 }
diff --git a/src/read_int.cpp b/src/read_int.cpp
@@ -24,12 +24,12 @@
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest einen Little-Endian kodierten Integer aus einer Datei.
+ *  Reads a Little-Endian encoded int from a FILE.
  *
- *  @param[out] to    Pointer auf Zielinteger
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    pointer to target int
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Null bei Erfolg, ein Wert ungleich Null bei Fehler
+ *  @return 0 on success, other values on error
  *
  *  @author FloSoft
  */
@@ -40,12 +40,12 @@ int libendian::le_read_i(int* to, FILE* file)
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest einen Little-Endian kodierten Unsigned Integer aus einer Datei.
+ *  Reads a Little-Endian encoded unsigned int from a FILE.
  *
- *  @param[out] to    Pointer auf Zielinteger
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    pointer to target int
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Null bei Erfolg, ein Wert ungleich Null bei Fehler
+ *  @return 0 on success, other values on error
  *
  *  @author FloSoft
  */
@@ -54,29 +54,25 @@ int libendian::le_read_ui(unsigned int* to, FILE* file)
     if(to == NULL || file == NULL)
         return -1;
 
-    // Integer einlesen
     if(fread(to, 1, 4, file) != 4)
         return 1;
 
-    // müssen wir konvertieren?
     if(BYTE_ORDER != LITTLE_ENDIAN)
     {
-        // ja, dann tauschen
         *to = swap_ui(*to);
     }
 
-    // alles ok
     return 0;
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest einen Big-Endian kodierten Integer aus einer Datei.
+ *  Reads a Big-Endian encoded int from a FILE.
  *
- *  @param[out] to    Pointer auf Zielinteger
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    pointer to target int
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Null bei Erfolg, ein Wert ungleich Null bei Fehler
+ *  @return 0 on success, other values on error
  *
  *  @author FloSoft
  */
@@ -87,12 +83,12 @@ int libendian::be_read_i(int* to, FILE* file)
 
 ///////////////////////////////////////////////////////////////////////////////
 /**
- *  liest einen Big-Endian kodierten Unsigned Integer aus einer Datei.
+ *  Reads a Big-Endian encoded unsigned int from a FILE.
  *
- *  @param[out] to    Pointer auf Zielinteger
- *  @param[in]  file  Datei aus der gelesen werden soll
+ *  @param[out] to    pointer to target int
+ *  @param[in]  file  file to read from
  *
- *  @return liefert Null bei Erfolg, ein Wert ungleich Null bei Fehler
+ *  @return 0 on success, other values on error
  *
  *  @author FloSoft
  */
@@ -101,17 +97,13 @@ int libendian::be_read_ui(unsigned int* to, FILE* file)
     if(to == NULL || file == NULL)
         return -1;
 
-    // Integer einlesen
     if(fread(to, 1, 4, file) != 4)
         return 1;
 
-    // müssen wir konvertieren?
     if(BYTE_ORDER != BIG_ENDIAN)
     {
-        // ja, dann tauschen
         *to = swap_ui(*to);
     }
 
-    // alles ok
     return 0;
 }