telyn / c2ephp

agents/CreatureHistory/CreatureHistoryEvent.php

Doc Comments +7 added lines, -7 removed lines

@@ -119,12 +119,12 @@ 
      * (number of seconds passed since 1st Jan, 1970)
      * @param $lifestage The lifestage this creature had achieved at
      * the time of this event.
-     * @param $moniker1 The first moniker associated with this event.
-     * @param $moniker2 The second moniker associated with this event.
-     * @param $usertext The user text assosciated with this event.
-     * @param $photograph The photograph associated with this event.
-     * @param $worldname The name of the world the creature was inhabiting at the time of this event 
-     * @param $worldUID The UID of the world the creature was inhabiting at the the time of this event
+     * @param false|string $moniker1 The first moniker associated with this event.
+     * @param false|string $moniker2 The second moniker associated with this event.
+     * @param false|string $usertext The user text assosciated with this event.
+     * @param false|string $photograph The photograph associated with this event.
+     * @param false|string $worldname The name of the world the creature was inhabiting at the time of this event 
+     * @param false|string $worldUID The UID of the world the creature was inhabiting at the the time of this event
      */
     public function CreatureHistoryEvent($eventtype, $worldtime, $creatureage, $timestamp, $lifestage, $moniker1, $moniker2, $usertext, $photograph, $worldname, $worldUID) {
         $this->eventtype = $eventtype;
@@ -142,7 +142,7 @@ 
 
     /// @brief Add DS-specific information to the CreatureHistoryEvent
     /**
-     * @param $DSUserID The UID of the Docking Station user whose world the creature was in at the time of the event
+     * @param false|string $DSUserID The UID of the Docking Station user whose world the creature was in at the time of the event
      * @param $unknown1 I don't know! But it comes right after the DSUID in the GLST format.
      * @param $unknown2 I don't know! But it comes right after unknown1.
      */

agents/PRAY/AGNTBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -13,7 +13,7 @@ 
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile associated with this AGNT block.
      * It is allowed to be null.
-     * @param $name The name of this block.
+     * @param string $name The name of this block.
      * @param $content This block's content.
      * @param $flags Any flags this block may have. I think this is a
      * single byte. Check http://www.creatureswiki.net/wiki/PRAY
@@ -26,7 +26,7 @@ 
     /**
      * Sometimes this ends in .agnt or .dsag, because some people
      * don't do their PRAYING properly.
-     * @return The agent name
+     * @return string agent name
      */
     public function GetAgentName() {
         return $this->GetName();

agents/PRAY/CREABlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile associated with this CREA block.
      * It is allowed to be null.
-     * @param $name The name of this block.
+     * @param string $name The name of this block.
      * @param $content This block's content.
      * @param $flags Any flags this block may have
      */

agents/PRAY/CreaturesArchiveBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 
     /// @brief Instantiates a new CreaturesArchiveBlock
     /**
-     * @param $prayfile The PRAYFile this CreaturesArchive belongs to. May be null.
+     * @param PRAYFile $prayfile The PRAYFile this CreaturesArchive belongs to. May be null.
      * @param $name The name of this block
      * @param $content This block's binary data.
      * @param $flags the flags of this block

agents/PRAY/DSAGBlock.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 $prayfile The PRAYFile that this DSAG block belongs to.
-     * @param $name The block's name.
+     * @param string $name The block's name.
      * @param $content The binary data of this block. May be null.
      * @param $flags The block's flags
      */

agents/PRAY/DSEXBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile that this DFAM block belongs to.
-     * @param $name The block's name.
+     * @param string $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

@@ -14,7 +14,7 @@
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile associated with this AGNT block.
      * It is allowed to be null.
-     * @param $name The name of this block.
+     * @param string $name The name of this block.
      * @param $content This block's content.
      * @param $flags Any flags this block may have. I think this is a
      * single byte. Check http://www.creatureswiki.net/wiki/PRAY

agents/PRAY/FILEBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile this FILEBlock belongs to. Can
      * be null.
-     * @param $name The name of this file block (also the file's
+     * @param string $name The name of this file block (also the file's
      * name)
      * @param $content The binary data of this file block.
      * @param $flags The block's flags. See PrayBlock.

agents/PRAY/GENEBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
      * @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 string $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.
      */