telyn / c2ephp

agents/COB/AgentBlock.php

Doc Comments +3 added lines, -3 removed lines

@@ -51,8 +51,8 @@ 
     /** As defaults can be made for everything else these are the only non-optional
      * parts of a COB file in my opinion. Even then they could just be '' if you
      * really felt like it. 
-     * @param $agentName The name of the agent (as displayed in the C2 injector)
-     * @param $agentDescription The description of the agent (as displayed in the C2 injector)
+     * @param string|false $agentName The name of the agent (as displayed in the C2 injector)
+     * @param string $agentDescription The description of the agent (as displayed in the C2 injector)
      */
     public function COBAgentBlock($agentName, $agentDescription) {
         parent::COBBlock(COB_BLOCK_AGENT);
@@ -381,7 +381,7 @@ 
 
     /// @brief Creates a new COBDependency
     /** @param string $type The type of dependency ('sprite' or 'sound').
-     * @param $name The name of the dependency (four characters, no file extension)
+     * @param string $name The name of the dependency (four characters, no file extension)
      */
     public function COBDependency($type, $name) {
         $this->type = $type;

agents/COB/FileBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -17,8 +17,8 @@
 	/// @brief Constructs a new COBFileBlock
     /**
      * @param string $type The file type
-	 * @param $name The file name (including extension)
-	 * @param $contents The contents of the file
+	 * @param string $name The file name (including extension)
+	 * @param string|false $contents The contents of the file
 	 */
 	public function COBFileBlock($type, $name, $contents) {
 		parent::COBBlock(COB_BLOCK_FILE);

Indentation +18 added lines, -18 removed lines

@@ -6,38 +6,38 @@
 
     /// @cond INTERNAL_DOCS
     //
-	private $fileType;
-	private $fileName;
+    private $fileType;
+    private $fileName;
 	
-	private $reserved;
+    private $reserved;
     private $contents;
 
     /// @endcond
 
-	/// @brief Constructs a new COBFileBlock
+    /// @brief Constructs a new COBFileBlock
     /**
      * @param string $type The file type
-	 * @param $name The file name (including extension)
-	 * @param $contents The contents of the file
-	 */
-	public function COBFileBlock($type, $name, $contents) {
-		parent::COBBlock(COB_BLOCK_FILE);
-		$this->fileType = $type;
-		$this->fileName = $name;
-		$this->contents = $contents;
+     * @param $name The file name (including extension)
+     * @param $contents The contents of the file
+     */
+    public function COBFileBlock($type, $name, $contents) {
+        parent::COBBlock(COB_BLOCK_FILE);
+        $this->fileType = $type;
+        $this->fileName = $name;
+        $this->contents = $contents;
     }
 
-	/// @brief Add the reserved data associated with this file block
+    /// @brief Add the reserved data associated with this file block
     /**
      * @param $reserved The reserved data
-	 */
-	public function AddReserved($reserved) {
-		$this->reserved = $reserved;
+     */
+    public function AddReserved($reserved) {
+        $this->reserved = $reserved;
     }
 
     /// @brief Get the name of the file
-	public function GetName() {
-		return $this->fileName;
+    public function GetName() {
+        return $this->fileName;
     }
 
     /// @brief Get the file's type

Spacing +2 added lines, -2 removed lines

@@ -70,12 +70,12 @@
      * @param $reader The reader the data's coming from
      */
     public static function CreateFromReader(IReader $reader) {
-        $type = ($reader->ReadInt(2)==0)?'sprite':'sound';
+        $type = ($reader->ReadInt(2) == 0) ? 'sprite' : 'sound';
         $reserved = $reader->ReadInt(4);
         $size = $reader->ReadInt(4);
         $fileName = $reader->ReadCString();
         $contents = $reader->Read($size);
-        $block = new COBFileBlock($type,$fileName,$contents);
+        $block = new COBFileBlock($type, $fileName, $contents);
         $block->AddReserved($reserved);
         return $block;
     }

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/DFAMBlock.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 $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
 	 */

Indentation +8 added lines, -8 removed lines

@@ -13,14 +13,14 @@
     /**
      * 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 $content The binary data of this block. May be null.
-	 * @param $flags The block's flags
-	 */
-	public function DFAMBlock($prayfile, $name, $content, $flags) {
-		parent::TagBlock($prayfile, $name, $content, $flags, PRAY_BLOCK_DFAM);
+     * @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
+     */
+    public function DFAMBlock($prayfile, $name, $content, $flags) {
+        parent::TagBlock($prayfile, $name, $content, $flags, PRAY_BLOCK_DFAM);
 
-	}
+    }
 }
 ?>

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
      */