Document @When step definitions

Author: swissspidy

src/Context/WhenStepDefinitions.php

@@ -7,7 +7,6 @@
 
 trait WhenStepDefinitions {
 
-
 	public function wpcli_tests_invoke_proc( $proc, $mode ) {
 		$map    = array(
 			'run' => 'run_check_stderr',
@@ -25,13 +24,23 @@ public function wpcli_tests_capture_email_sends( $stdout ) {
 	}
 
 	/**
+	 * Launch a given command in the background.
+	 *
+	 * @access public
+	 *
 	 * @When /^I launch in the background `([^`]+)`$/
 	 */
 	public function when_i_launch_in_the_background( $cmd ) {
 		$this->background_proc( $cmd );
 	}
 
 	/**
+	 * Run or try a given command.
+	 *
+	 * `run` expects an exit code 0, whereas `try` allows for non-zero exit codes.
+	 *
+	 * @access public
+	 *
 	 * @When /^I (run|try) `([^`]+)`$/
 	 */
 	public function when_i_run( $mode, $cmd ) {
@@ -41,6 +50,12 @@ public function when_i_run( $mode, $cmd ) {
 	}
 
 	/**
+	 * Run or try a given command in a subdirectory.
+	 *
+	 * `run` expects an exit code 0, whereas `try` allows for non-zero exit codes.
+	 *
+	 * @access public
+	 *
 	 * @When /^I (run|try) `([^`]+)` from '([^\s]+)'$/
 	 */
 	public function when_i_run_from_a_subfolder( $mode, $cmd, $subdir ) {
@@ -50,6 +65,12 @@ public function when_i_run_from_a_subfolder( $mode, $cmd, $subdir ) {
 	}
 
 	/**
+	 * Run or try the previous command again.
+	 *
+	 * `run` expects an exit code 0, whereas `try` allows for non-zero exit codes.
+	 *
+	 * @access public
+	 *
 	 * @When /^I (run|try) the previous command again$/
 	 */
 	public function when_i_run_the_previous_command_again( $mode ) {