diff options
| author | piernov <piernov@piernov.org> | 2016-05-09 14:05:50 +0200 |
|---|---|---|
| committer | piernov <piernov@piernov.org> | 2016-05-09 14:05:50 +0200 |
| commit | 1e52affe15fb13e920f8942de998073238be6d01 (patch) | |
| tree | b0737eb2c9f26be6700f99d00d003e4cf6b05d7b /doc/phpdoc/classes/Inventory.html | |
| parent | 9f28616dfd1cc425c5013937bab729217b7be2e6 (diff) | |
| download | candybox-1e52affe15fb13e920f8942de998073238be6d01.tar.gz candybox-1e52affe15fb13e920f8942de998073238be6d01.tar.bz2 candybox-1e52affe15fb13e920f8942de998073238be6d01.tar.xz candybox-1e52affe15fb13e920f8942de998073238be6d01.zip | |
Finish Inventory PHPDocphpdoc
Diffstat (limited to 'doc/phpdoc/classes/Inventory.html')
| -rw-r--r-- | doc/phpdoc/classes/Inventory.html | 135 |
1 files changed, 35 insertions, 100 deletions
diff --git a/doc/phpdoc/classes/Inventory.html b/doc/phpdoc/classes/Inventory.html index 48730e5..18149d5 100644 --- a/doc/phpdoc/classes/Inventory.html +++ b/doc/phpdoc/classes/Inventory.html @@ -124,8 +124,8 @@ </li> <li class="method public"> - <a href="#method_addToXML" title="addToXML :: "> - <span class="description"></span><pre>addToXML</pre> + <a href="#method_addToXML" title="addToXML :: Generates an XML tree describing the Inventory"> + <span class="description">Generates an XML tree describing the Inventory</span><pre>addToXML</pre> </a> </li> @@ -142,8 +142,8 @@ </li> <li class="method public"> - <a href="#method_removeItem" title="removeItem :: "> - <span class="description"></span><pre>removeItem</pre> + <a href="#method_removeItem" title="removeItem :: Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count."> + <span class="description">Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count.</span><pre>removeItem</pre> </a> </li> @@ -154,8 +154,8 @@ </li> <li class="method public"> - <a href="#method_useItem" title="useItem :: "> - <span class="description"></span><pre>useItem</pre> + <a href="#method_useItem" title="useItem :: Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0."> + <span class="description">Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0.</span><pre>useItem</pre> </a> </li> @@ -173,13 +173,13 @@ </a> </li> <li class="method private"> - <a href="#method__removeItem" title="_removeItem :: "> - <span class="description"></span><pre>_removeItem</pre> + <a href="#method__removeItem" title="_removeItem :: Removes an Item object from the Inventory, not taking into account the Item's count."> + <span class="description">Removes an Item object from the Inventory, not taking into account the Item's count.</span><pre>_removeItem</pre> </a> </li> <li class="method private"> - <a href="#method__useItem" title="_useItem :: "> - <span class="description"></span><pre>_useItem</pre> + <a href="#method__useItem" title="_useItem :: Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0."> + <span class="description">Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0.</span><pre>_useItem</pre> </a> </li> </ul> @@ -264,8 +264,8 @@ </div> <a id="method__removeItem"></a> <div class="element clickable method private method__removeItem" data-toggle="collapse" data-target=".method__removeItem .collapse"> - <h2>_removeItem</h2> - <pre>_removeItem( $item) </pre> + <h2>Removes an Item object from the Inventory, not taking into account the Item's count.</h2> + <pre>_removeItem(\Item $item) : void</pre> <div class="labels"> </div> @@ -275,26 +275,12 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to remove from the Inventory</p></p> </div> </div> @@ -303,8 +289,8 @@ </div> <a id="method__useItem"></a> <div class="element clickable method private method__useItem" data-toggle="collapse" data-target=".method__useItem .collapse"> - <h2>_useItem</h2> - <pre>_useItem( $item) </pre> + <h2>Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0.</h2> + <pre>_useItem(\Item $item) : array|false</pre> <div class="labels"> </div> @@ -314,28 +300,16 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to consume from the Inventory</p></p> </div> + <h3>Response</h3> + <code>array|false</code><p><p>Item and updated Item's count, false if it was not found</p></p> </div> </div> @@ -369,8 +343,8 @@ </div> <a id="method_addToXML"></a> <div class="element clickable method public method_addToXML" data-toggle="collapse" data-target=".method_addToXML .collapse"> - <h2>addToXML</h2> - <pre>addToXML( $root) </pre> + <h2>Generates an XML tree describing the Inventory</h2> + <pre>addToXML(\SimpleXMLElement $root) : void</pre> <div class="labels"> </div> @@ -380,26 +354,12 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$root</h4> - <code></code><p></p> + <code>\SimpleXMLElement</code><p><p>root XML element to add the Inventory's Items to</p></p> </div> </div> @@ -466,8 +426,8 @@ </div> <a id="method_removeItem"></a> <div class="element clickable method public method_removeItem" data-toggle="collapse" data-target=".method_removeItem .collapse"> - <h2>removeItem</h2> - <pre>removeItem( $item) </pre> + <h2>Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count.</h2> + <pre>removeItem(\Item $item) : void</pre> <div class="labels"> <span class="label">static</span> </div> @@ -477,26 +437,12 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to remove from the Inventory</p></p> </div> </div> @@ -534,8 +480,8 @@ </div> <a id="method_useItem"></a> <div class="element clickable method public method_useItem" data-toggle="collapse" data-target=".method_useItem .collapse"> - <h2>useItem</h2> - <pre>useItem( $item) </pre> + <h2>Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0.</h2> + <pre>useItem(\Item $item) : array|false</pre> <div class="labels"> <span class="label">static</span> </div> @@ -545,28 +491,16 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to consume from the Inventory</p></p> </div> + <h3>Response</h3> + <code>array|false</code><p><p>Item and updated Item's count, false if it was not found</p></p> </div> </div> @@ -576,8 +510,8 @@ <h3><i class="icon-custom icon-property"></i> Properties</h3> <a id="property_items"> </a> <div class="element clickable property public property_items" data-toggle="collapse" data-target=".property_items .collapse"> - <h2>Arrays of array with Item and Item's count</h2> - <pre>items : </pre> + <h2>Arrays of array with Item object and Item's count as int</h2> + <pre>items : array</pre> <div class="labels"> </div> <div class="row collapse"> @@ -587,15 +521,16 @@ <table class="table"> <tr> <th> - + var </th> <td> + <p>Arrays of array with Item object and Item's count as int</p> </td> </tr> </table> <h3>Type(s)</h3> - <code></code> + <code>array</code> </div> </div> </div> @@ -619,7 +554,7 @@ Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br/> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/> - generated on Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> |