telyn / c2ephp

agents/PRAY/DSEXBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile that this DFAM block belongs to.
+     * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to.
      * @param $name The block's name.
      * @param $content The binary data of this block. May be null.
      * @param $flags The block's flags

agents/PRAY/EGGSBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
      * Makes a new EGGSBlock. \n
      * If $prayfile is not null, all the data about this AGNTBlock
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile associated with this AGNT block.
+     * @param PRAYFile $prayfile The PRAYFile associated with this AGNT block.
      * It is allowed to be null.
      * @param $name The name of this block.
      * @param $content This block's content.

agents/PRAY/EXPCBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile that this DFAM block belongs to.
+     * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to.
      * @param $name The block's name.
      * @param $content The binary data of this block. May be null.
      * @param $flags The block's flags

agents/PRAY/FILEBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
      * FILEBlocks are currently read-only. \n
      * If $prayfile is not null, all the data about this block
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile this FILEBlock belongs to. Can
+     * @param PRAYFile $prayfile The PRAYFile this FILEBlock belongs to. Can
      * be null.
      * @param $name The name of this file block (also the file's
      * name)

agents/PRAY/GENEBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile object this block belongs to. Can be null.
+     * @param PRAYFile $prayfile The PRAYFile object this block belongs to. Can be null.
      * @param $name The block's name. This is a creature's moniker with .genetics appended.
      * @param $content The block's binary data. Used when constructing from a PrayFile
      * @param $flags The block's flags, which apply to the binary data as-is.

agents/PRAY/GLSTBlock.php

Doc Comments +6 added lines, -2 removed lines

@@ -31,7 +31,7 @@ 
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-     * @param $object The PRAYFile this FILEBlock belongs to, or the
+     * @param PRAYFile $object The PRAYFile this FILEBlock belongs to, or the
      * CreatureHistory object to store. <b>Cannot</b> be null.
      * @param $name The name of this block. I think it's usually the
      * creature's moniker with .GLST appended.
@@ -172,6 +172,10 @@ 
 
 
     /// @brief Decodes an event. Used by DecompileBlockData.
+
+    /**
+     * @param StringReader $reader
+     */
     private function DecodeEvent($reader) {
         $eventNumber = $reader->ReadInt(4);
         //echo 'Event '.$eventNumber."\n";
@@ -206,7 +210,7 @@ 
     /// @brief Compiles the block into binary for PrayBlock
     /**
      * @param $format One of the GLST_FORMAT_* constants
-     * @return The compiled block data for Compile()
+     * @return false|string compiled block data for Compile()
      */
     protected function CompileBlockData($format=GLST_FORMAT_UNKNOWN) {
         //if you don't know

agents/PRAY/LIVEBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile this LIVEBlock belongs to.
+     * @param PRAYFile $prayfile The PRAYFile this LIVEBlock belongs to.
      * @param $name The name of this block
      * @param $content The binary data of this file block.
      * @param $flags The block's flags. See PrayBlock.

agents/PRAY/PHOTBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile that this DSAG block belongs to.
+     * @param PRAYFile $prayfile The PRAYFile that this DSAG block belongs to.
      * @param $name The block's name.
      * @param $content The binary data of this block. May be null.
      * @param $flags The block's flags
@@ -38,7 +38,7 @@ 
 
     /// @brief Returns the photo data as an s16 file. <b>Deprecated.</b>
     /**
-     * @return The photo data as an S16File object.
+     * @return S16File photo data as an S16File object.
      */
     public function GetS16File() {
         return new S16File(new StringReader($this->GetData()));

agents/PRAY/PrayBlock.php

Doc Comments +7 added lines, -6 removed lines

@@ -102,7 +102,7 @@ 
 
     /// @brief Encodes the block header for attaching to the front of the block binary data.
     /** 
-     * @param $length length of the data that will be written to the block
+     * @param integer $length length of the data that will be written to the block
      * @param $uncompressedlength length of the data when uncompressed, etc.
      */
     protected function EncodeBlockHeader($length,$uncompressedlength=false) {
@@ -127,7 +127,7 @@ 
     /** 
      * Called automatically during Compile
      * @param $data the data to perform the function on
-     * @return the data, having been transformed.
+     * @return boolean|string data, having been transformed.
      */
     protected function PerformFlagOperations($data) {
         if($this->IsFlagSet(PRAY_FLAG_ZLIB_COMPRESSED)) {
@@ -140,6 +140,7 @@ 
 
     /// @brief Gets the PRAY block's name
     /** return the PRAY block's name
+     * @return string
      */
     public function GetName() {
         return $this->name;
@@ -181,8 +182,8 @@ 
     }
     /// @brief Tells you whether $flag is set on this PRAY block
     /**
-     * @param $flag the bitfield to compare $flags to. As such can be multiple flags OR'd together.
-     * @return true or false.
+     * @param integer $flag the bitfield to compare $flags to. As such can be multiple flags OR'd together.
+     * @return boolean or false.
      */
     public function IsFlagSet($flag) {
         return (($this->flags & $flag) === $flag);
@@ -222,7 +223,7 @@ 
     }
     /// @brief Unsets flags
     /**
-     * @param $flags a bitfield representing the flags to set off.
+     * @param integer $flags a bitfield representing the flags to set off.
      */
     protected function SetFlagsOff($flags) {
         $this->flags = $this->flags & ~$flags;
@@ -288,7 +289,7 @@ 
     /** For developer use. Called by 
      *   @param $blocktype   The type of PRAYBlock, as one of the Block Types defines.
      *   @param $prayfile    The PRAYFile object that the PRAYBlock is a child of. This is used to allow blocks to access to each other.
-     *   @param $name        The name of the PRAYBlock
+     *   @param string $name        The name of the PRAYBlock
      *   @param $content     The binary content of the PRAYBlock, uncompressed if necessary.
      *   @param $flags       The flags given to this PRAYBlock as an integer.
      *   return An object that is an instance of a subclass of PrayBlock.