telyn / c2ephp

agents/PRAY/TagBlock.php

Doc Comments +2 added lines, -1 removed lines

@@ -25,7 +25,7 @@ 
      * @param $name The name of the block. Cannot be null.
      * @param $content The binary data this block contains. Can be null.
      * @param $flags The flags relating to this block. Should be zero or real flags.
-     * @param $type The block's 4-character type. Must be defined.
+     * @param string $type The block's 4-character type. Must be defined.
      */
     public function TagBlock($prayfile,$name,$content,$flags,$type) {
         parent::PrayBlock($prayfile,$name,$content,$flags,$type);
@@ -40,6 +40,7 @@ 
     /**
      * Returns the tag's value as a string, or
      * nothing if the tag doesn't exist.
+     * @param string $key
      */
     public function GetTag($key) {
         $this->EnsureDecompiled();

agents/PRAYFile.php

Doc Comments +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
 
     /// @brief Compiles the PRAYFile.
     /**
-     * @return A binary string containing the PRAYFile's contents.
+     * @return string binary string containing the PRAYFile's contents.
      */
     public function Compile() {
         $compiled = 'PRAY';

sprites/C16File.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
     }
     /// @brief Compiles the file's data into a C16 binary string
     /**
-     * @return A binary string containing the C16File's data.
+     * @return string binary string containing the C16File's data.
      */
     public function Compile() {
         $data = ''; 

sprites/S16File.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 
     /// @brief Compiles the S16 file into a binary string.
     /**
-     * @return a binary string containing s16 data of whatever the
+     * @return string binary string containing s16 data of whatever the
      * current encoding set by SetEncoding() is. If you haven't set
      * it, it's most likely 565.
      */

sprites/S16Frame.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     /// @brief Encodes the image into s16 frame data.
     /**
      * @param $format 555 or 565.
-     * @return s16 image data in the format specified
+     * @return string image data in the format specified
      */
 
     public function Encode($format='565') {

sprites/SPRFrame.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
      * Called automatically by SPRFile::Compile() \n
      * Generally end-users won't want a single frame of SPR data,
      * so add it to an SPRFile and call SPRFile::Compile().
-     * @return a binary string of SPR data.
+     * @return string binary string of SPR data.
      */
     public function Encode() {
         $data = '';

sprites/SpriteFile.php

Doc Comments +4 added lines, -1 removed lines

@@ -11,6 +11,9 @@ 
 
   /// @cond INTERNAL_DOCS
   
+  /**
+   * @param string $filetype
+   */
   public function SpriteFile($filetype) {
     $this->spritefiletype = $filetype;
   }
@@ -102,7 +105,7 @@ 
   /**
    * May be removed in a future release.
    * Use GetFrame($frame)->ToPNG() instead.
-   * @param $frame The 0-based index of the frame to delete.
+   * @param integer $frame The 0-based index of the frame to delete.
    * @return A binary string containing a PNG.
    */
   public function ToPNG($frame) {

sprites/SpriteFrame.php

Doc Comments +8 added lines, -4 removed lines

@@ -42,7 +42,7 @@ 
     /// @brief Gets the GD Image resource for this sprite frame.
     /// <strong> Deprecated</strong>
     /**
-     *  @return a GD image resource. See http://php.net/image 
+     *  @return resource GD image resource. See http://php.net/image 
      */
     public function GetGDImage() {
         $this->EnsureDecoded();
@@ -54,6 +54,10 @@ 
         return $this->width;
     }
     /// @brief Gets the height of the frame in pixels
+
+    /**
+     * @return integer
+     */
     public function GetHeight() {
         return $this->height;
     }
@@ -69,8 +73,8 @@ 
      *    [alpha] => 0 
      * )</pre>
      * @see http://php.net/imagecolorsforindex
-     * @param $x The x-coordinate of the pixel to get.
-     * @param $y The y-coordinate of the pixel to get.
+     * @param integer $x The x-coordinate of the pixel to get.
+     * @param integer $y The y-coordinate of the pixel to get.
      * @return An associative array containing the keys 'red','green','blue','alpha'.
      */
     public function GetPixel($x,$y) {
@@ -150,7 +154,7 @@ 
 
     /// @brief Converts this SpriteFrame into a PNG.
     /**
-     * @return A binary string in PNG format, ready for output! :)
+     * @return string binary string in PNG format, ready for output! :)
      */
     public function ToPNG() {
         $this->EnsureDecoded();

support/Archiver.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 		return false; //coming soon
 	}	
 }
+/**
+ * @param string $data
+ */
 function Archive($data,$filehandle=null) {
 	if(is_resource($filehandle)) {
 		return false;