Merge pull request #646 from Codeception/document-parameters

Document parameters and return types

Author: Naktibalda

composer.json

@@ -32,12 +32,17 @@
     "codeception/module-yii2": "*",
     "codeception/util-robohelpers": "dev-master",
     "knplabs/github-api": "^3.0",
-    "guzzlehttp/guzzle": "^7.0.1",
-    "http-interop/http-factory-guzzle": "^1.0"
+    "guzzlehttp/guzzle": "^7.0.1"
   },
   "require-dev": {
-    "consolidation/robo": "3.x-dev"
+    "consolidation/robo": "dev-document-method-parameters"
   },
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://github.com/Naktibalda/robo.git"
+    }
+  ],
   "config": {
     "platform": {
       "ext-phalcon": "4.1.1"

docs/modules/AMQP.md

@@ -69,7 +69,15 @@ To use this module with Composer you need <em>"php-amqplib/php-amqplib": "~2.4"<
 ### Actions
 
 #### bindQueueToExchange
- 
+
+* `param string` $queue
+* `param string` $exchange
+* `param string` $routing_key
+* `param bool` $nowait
+* `param ?array` $arguments
+* `param ?int` $ticket
+* `return mixed`
+
 Binds a queue to an exchange
 
 This is an alias of method `queue_bind` of `PhpAmqpLib\Channel\AMQPChannel`.
@@ -86,9 +94,19 @@ $I->bindQueueToExchange(
 {% endhighlight %}
 
 
-
 #### declareExchange
- 
+
+* `param string` $exchange
+* `param string` $type
+* `param bool` $passive
+* `param bool` $durable
+* `param bool` $auto_delete
+* `param bool` $internal
+* `param bool` $nowait
+* `param ?array` $arguments
+* `param ?int` $ticket
+* `return mixed`
+
 Declares an exchange
 
 This is an alias of method `exchange_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
@@ -104,9 +122,18 @@ $I->declareExchange(
 {% endhighlight %}
 
 
-
 #### declareQueue
- 
+
+* `param string` $queue
+* `param bool` $passive
+* `param bool` $durable
+* `param bool` $exclusive
+* `param bool` $auto_delete
+* `param bool` $nowait
+* `param ?array` $arguments
+* `param ?int` $ticket
+* `return mixed`
+
 Declares queue, creates if needed
 
 This is an alias of method `queue_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
@@ -121,9 +148,11 @@ $I->declareQueue(
 {% endhighlight %}
 
 
-
 #### dontSeeQueueIsEmpty
- 
+
+* `param string` $queue
+* `return void`
+
 Checks if queue is not empty.
 
 {% highlight php %}
@@ -136,7 +165,10 @@ $I->dontSeeQueueIsEmpty('queue.emails');
 
 
 #### grabMessageFromQueue
- 
+
+* `param string` $queue
+* `return ?\PhpAmqpLib\Message\AMQPMessage`
+
 Takes last message from queue.
 
 {% highlight php %}
@@ -148,7 +180,9 @@ $message = $I->grabMessageFromQueue('queue.emails');
 
 
 #### purgeAllQueues
- 
+
+* `return void`
+
 Purge all queues defined in config.
 
 {% highlight php %}
@@ -160,7 +194,10 @@ $I->purgeAllQueues();
 
 
 #### purgeQueue
- 
+
+* `param string` $queueName
+* `return void`
+
 Purge a specific queue defined in config.
 
 {% highlight php %}
@@ -172,7 +209,12 @@ $I->purgeQueue('queue.emails');
 
 
 #### pushToExchange
- 
+
+* `param string` $exchange
+* `param \PhpAmqpLib\Message\AMQPMessage|string` $message
+* `param ?string` $routing_key
+* `return void`
+
 Sends message to exchange by sending exchange name, message
 and (optionally) a routing key
 
@@ -187,7 +229,11 @@ $I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'), 'severity');
 
 
 #### pushToQueue
- 
+
+* `param string` $queue
+* `param \PhpAmqpLib\Message\AMQPMessage|string` $message
+* `return void`
+
 Sends message to queue
 
 {% highlight php %}
@@ -200,12 +246,19 @@ $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
 
 
 #### scheduleQueueCleanup
- 
+
+* `param string` $queue
+* `return void`
+
 Add a queue to purge list
 
 
 #### seeMessageInQueueContainsText
- 
+
+* `param string` $queue
+* `param string` $text
+* `return void`
+
 Checks if message containing text received.
 
 **This method drops message from queue**
@@ -221,7 +274,11 @@ $I->seeMessageInQueueContainsText('queue.emails','davert');
 
 
 #### seeNumberOfMessagesInQueue
- 
+
+* `param string` $queue
+* `param int` $expected
+* `return void`
+
 Checks that queue have expected number of message
 
 {% highlight php %}
@@ -234,7 +291,10 @@ $I->seeNumberOfMessagesInQueue('queue.emails',1);
 
 
 #### seeQueueIsEmpty
- 
+
+* `param string` $queue
+* `return void`
+
 Checks that queue is empty
 
 {% highlight php %}

docs/modules/Apc.md

@@ -58,7 +58,11 @@ Be sure you don't use the production server to connect.
 ### Actions
 
 #### dontSeeInApc
- 
+
+* `param string` $key
+* `param mixed` $value
+* `return void`
+
 Checks item in APCu doesn't exist or is the same as expected.
 
 Examples:
@@ -76,12 +80,17 @@ $I->dontSeeInApc('users_count', 200);
 
 
 #### flushApc
- 
+
+* `return void`
+
 Clears the APCu cache
 
 
 #### grabValueFromApc
- 
+
+* `param string` $key
+* `return mixed`
+
 Grabs value from APCu by key.
 
 Example:
@@ -95,7 +104,12 @@ $users_count = $I->grabValueFromApc('users_count');
 
 
 #### haveInApc
- 
+
+* `param string` $key
+* `param mixed` $value
+* `param int` $expiration
+* `return string`
+
 Stores an item `$value` with `$key` on the APCu.
 
 Examples:
@@ -121,7 +135,11 @@ $I->haveInApc($entries, null);
 
 
 #### seeInApc
- 
+
+* `param string` $key
+* `param mixed` $value
+* `return void`
+
 Checks item in APCu exists and the same as expected.
 
 Examples:
@@ -137,5 +155,4 @@ $I->seeInApc('users_count', 200);
 
 {% endhighlight %}
 
-
 <p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-apc/tree/master/src/Codeception/Module/Apc.php">Help us to improve documentation. Edit module reference</a></div>