telyn / c2ephp

agents/COB/AgentBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -104,7 +104,7 @@ 
         return $this->eventScripts[$whichScript];
     }
     /// @brief Gets the thumbnail of this agent as would be shown in the Injector
-    /** @return A SpriteFrame of the thumbnail
+    /** @return SpriteFrame SpriteFrame of the thumbnail
      */
     public function GetThumbnail() {
         return $this->thumbnail;
@@ -380,7 +380,7 @@ 
     /// @endcond
 
     /// @brief Creates a new COBDependency
-    /** @param $type The type of dependency ('sprite' or 'sound').
+    /** @param string $type The type of dependency ('sprite' or 'sound').
      * @param $name The name of the dependency (four characters, no file extension)
      */
     public function COBDependency($type,$name) {

agents/COB/FileBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 
 	/// @brief Constructs a new COBFileBlock
     /**
-     * @param $type The file type
+     * @param string $type The file type
 	 * @param $name The file name (including extension)
 	 * @param $contents The contents of the file
 	 */

Indentation +34 added lines, -34 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 $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
@@ -45,13 +45,13 @@ 
      * @return 'sprite' or 'sound' - i.e. one of the
      * COB_DEPENDENCY_* constants in COBAgentBlock
      */
-	public function GetFileType() {
-		return $this->fileType;
+    public function GetFileType() {
+        return $this->fileType;
     }
 
     /// @brief Get the contents of the file.
-	public function GetContents() {
-		return $this->contents;
+    public function GetContents() {
+        return $this->contents;
     }
 
     /// @brief Get the reserved data
@@ -59,8 +59,8 @@ 
      * Reserved data was never officially used.
      * @return A 4-byte integer.
      */
-	public function GetReserved() {
-		return $this->reserved;
+    public function GetReserved() {
+        return $this->reserved;
     }
 
     /// @cond INTERNAL_DOCS
@@ -68,16 +68,16 @@ 
     /// @brief Creates a new COBFileBlock from an IReader
     /**
      * @param $reader The reader the data's coming from
-	 */
-	public static function CreateFromReader(IReader $reader) {
-		$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->AddReserved($reserved);
-		return $block;
+     */
+    public static function CreateFromReader(IReader $reader) {
+        $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->AddReserved($reserved);
+        return $block;
     }
     /// @endcond
 }

agents/CreatureHistory/CreatureHistory.php

Doc Comments +8 added lines, -8 removed lines

@@ -43,8 +43,8 @@ 
 
     /// @brief Construct a CreatureHistory object.
     /**
-     * @param $moniker The moniker of the creature
-     * @param $name The creature's name
+     * @param false|string $moniker The moniker of the creature
+     * @param false|string $name The creature's name
      * @param $gender The creature's gender
      * @param $genus The creature's genus (Grendel, ettin, norn, geat)
      * @param $species The creature's species (unsure of purpose)  
@@ -60,7 +60,7 @@ 
     /// @brief Compiles the CreatureHistory into CreaturesArchive data.
     /**
      * @param $format GLST_FORMAT_C3 or GLST_FORMAT_DS.
-     * @return A binary string ready for archiving and putting in a GLST block. 
+     * @return string binary string ready for archiving and putting in a GLST block. 
      */
     public function Compile($format=GLST_FORMAT_C3) {
         $data = '';
@@ -93,7 +93,7 @@ 
     /**
      * This is done by working out whether any DS-specific variables
      * are set.
-     * @return GLST_FORMAT_DS or GLST_FORMAT_C3.
+     * @return integer or GLST_FORMAT_C3.
      */
     public function GuessFormat() {
         return (isset($this->unknown1))?GLST_FORMAT_DS:GLST_FORMAT_C3;
@@ -112,7 +112,7 @@ 
     /**
      * Simply gets the nth event that happened in this history
      * @param $n the event number to get
-     * @return the $nth CreatureHistoryEvent 
+     * @return CreatureHistoryEvent $nth CreatureHistoryEvent 
      */
     public function GetEvent($n) {
         return $this->events[$n];
@@ -153,7 +153,7 @@ 
 
     /// Gets all the events in this history
     /**
-     * @return An array of CreatureHistoryEvents 
+     * @return CreatureHistoryEvent[] array of CreatureHistoryEvents 
      */
     public function GetEvents() {
         return $this->events;
@@ -229,7 +229,7 @@ 
     /**
      * This calls SetC3Unknown
      * @param $unknown1 First unknown variable
-     * @param $unknown2 Second unknown variable
+     * @param false|string $unknown2 Second unknown variable
      */
     public function SetDSUnknowns($unknown1,$unknown2) {
         $this->unknown1 = $unknown1;
@@ -238,7 +238,7 @@ 
 
     /// @brief Sets whether or not the creature is a veteran of the warp (DS only)
     /**
-     * @param $warpveteran A boolean (I think!)
+     * @param integer $warpveteran A boolean (I think!)
      */
     public function SetWarpVeteran($warpveteran) {
         $this->warpveteran = $warpveteran;

Indentation +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
      * @param $n the event number to remove
      */
     public function RemoveEvent($n) {
-       unset($this->events[$n]); 
+        unset($this->events[$n]); 
     }
 
     /// @brief Counts the events in the history

agents/CreatureHistory/CreatureHistoryEvent.php

Doc Comments +1 added lines, -1 removed lines

@@ -158,7 +158,7 @@
      * This is called automatically by CreatureHistory, most users
      * should have no need to use this function themselves.
      * @param $format Which game to compile it for (a GLST_FORMAT_* constant)
-     * @return A binary string containing GLST data ready to be put into a GLST history.
+     * @return string binary string containing GLST data ready to be put into a GLST history.
      */
     public function Compile($format) {
         $data = pack('VVVVV',$this->eventtype,$this->worldtime,$this->creatureage,$this->timestamp,$this->lifestage);

agents/PRAY/AGNTBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -11,7 +11,7 @@ 
      * Makes a new AGNTBlock. \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.
@@ -75,7 +75,7 @@ 
         return $this->GetTag('Dependency Count');
     }
     /// @brief Gets the dependency specified
-    /** @param $dependency The number of the dependency to get. 1-based.
+    /** @param integer $dependency The number of the dependency to get. 1-based.
      * return A PrayDependency object describing the file the agent depends on
      */
     

agents/PRAY/BinaryBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
     }
     /// @brief Compile the BinaryBlock
     /**
-     * @return The compiled BinaryBlock as a binary string.
+     * @return string compiled BinaryBlock as a binary string.
      */
 	public function Compile() {
 		return $this->EncodeBlockHeader(strlen($this->binarydata)).$this->binarydata;

Indentation +7 added lines, -7 removed lines

@@ -13,7 +13,7 @@ 
 class BinaryBlock extends PrayBlock {
     /// @cond INTERNAL_DOCS
     
-	private $binarydata;
+    private $binarydata;
     /// @endcond
 
     /// @brief Instantiate a BinaryBlock
@@ -22,17 +22,17 @@ 
      * @param $name The block's name.
      * @param $content The content of the block as a binary string.
      */
-	public function BinaryBlock($type,$name,$content) {
-		parent::PrayBlock(null,$name,'',0,$type);
-		$this->binarydata = $content;
+    public function BinaryBlock($type,$name,$content) {
+        parent::PrayBlock(null,$name,'',0,$type);
+        $this->binarydata = $content;
     }
     /// @brief Compile the BinaryBlock
     /**
      * @return The compiled BinaryBlock as a binary string.
      */
-	public function Compile() {
-		return $this->EncodeBlockHeader(strlen($this->binarydata)).$this->binarydata;
-	}
+    public function Compile() {
+        return $this->EncodeBlockHeader(strlen($this->binarydata)).$this->binarydata;
+    }
 }
 
 ?>

agents/PRAY/CREABlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
     /**
      * If $prayfile is not null, all the data about this CREABlock
      * will be read from the PRAYFile.
-     * @param $prayfile The PRAYFile associated with this CREA block.
+     * @param PRAYFile $prayfile The PRAYFile associated with this CREA block.
      * It is allowed to be null.
      * @param $name The name of this block.
      * @param $content This block's content.

agents/PRAY/CreaturesArchiveBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      * @param $name The name of this block
      * @param $content This block's binary data.
      * @param $flags the flags of this block
-     * @param $type This block's type as one of the PRAY_BLOCK_* constants
+     * @param string $type This block's type as one of the PRAY_BLOCK_* constants
      */
     public function CreaturesArchiveBlock(&$prayfile,$name,$content,$flags,$type) {
         parent::PrayBlock($prayfile,$name,$content,$flags,$type);

agents/PRAY/DFAMBlock.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 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

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 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 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);
 
-	}
+    }
 }
 ?>