telyn / c2ephp

support/IReader.php

Doc Comments +10 added lines, -1 removed lines

@@ -12,13 +12,14 @@ 
 interface IReader {
     /// @brief Reads an integer
     /**
-     * @param $length Length of the integer in bytes.
+     * @param integer $length Length of the integer in bytes.
      */
     public function ReadInt($length);
 
     /// @brief Reads a string
     /**
      * @param $length Length of the string to read in bytes
+     * @return string|false
      */
     public function Read($length);
 
@@ -30,24 +31,32 @@ 
      * memory-wise, but it simplifies the code and c2e files don't
      * tend to get big enough to make this inefficiency a concern on
      * any reasonably modern hardware.
+     * @return string
      */
     public function GetSubString($start,$length=FALSE);
     /// @brief Gets the position of the cursor
     /**
      * This is analagous to ftell in C or PHP.
+     * @return integer
      */
     public function GetPosition();
     /// @brief Changes the current position in the reader's stream
     /**
      * This is analagous to fseek in C or PHP.
+     * @return void
      */
     public function Seek($position); 
     /// @brief Advances the position of the reader by $count.
+
+    /**
+     * @return void
+     */
     public function Skip($count);
     /// @brief Reads a c-style string at the current position.
     /**
      * C-style means that the string is terminated by a NUL (0) 
      * character.
+     * @return string
      */
     public function ReadCString(); //read a string of unknown length until the first NUL
 }

support/StringReader.php

Doc Comments +11 added lines

@@ -50,12 +50,20 @@ 
     public function Skip($count) {
         $this->position += $count;
     }
+
+    /**
+     * @param integer $characters
+     */
     public function ReadInt($characters) {
         return BytesToIntLilEnd($this->Read($characters));
     }
     public function GetPosition() {
         return $this->position;
     }
+
+    /**
+     * @param integer $start
+     */
     public function GetSubString($start,$length = FALSE) {
         if($length == FALSE) {
             $length = strlen($this->string)-$start;
@@ -65,6 +73,9 @@ 
     }
 }
 
+/**
+ * @param false|string $string
+ */
 function BytesToIntLilEnd($string) { //little endian
     if($string == "") {
         return false;