Issue #2039449 by joshi.rohit100, joachim, lokapujya, Jalandhar, paulh, yaworsk: Fix up docs for assertField and assertNoField methods

merge-requests/26/head
Jennifer Hodgdon 2014-06-25 15:13:44 -07:00
parent 7e6ba8f2f7
commit 066c628c86
1 changed files with 44 additions and 29 deletions

View File

@ -3187,7 +3187,7 @@ class DrupalWebTestCase extends DrupalTestCase {
* @param $callback
* The name of the theme function to invoke; e.g. 'links' for theme_links().
* @param $variables
* An array of variables to pass to the theme function.
* (optional) An array of variables to pass to the theme function.
* @param $expected
* The expected themed output string.
* @param $message
@ -3223,7 +3223,9 @@ class DrupalWebTestCase extends DrupalTestCase {
* @param $xpath
* XPath used to find the field.
* @param $value
* (optional) Value of the field to assert.
* (optional) Value of the field to assert. You may pass in NULL (default)
* to skip checking the actual value, while still checking that the field
* exists.
* @param $message
* (optional) Message to display.
* @param $group
@ -3291,12 +3293,14 @@ class DrupalWebTestCase extends DrupalTestCase {
}
/**
* Asserts that a field does not exist in the current page by the given XPath.
* Asserts that a field doesn't exist or its value doesn't match, by XPath.
*
* @param $xpath
* XPath used to find the field.
* @param $value
* (optional) Value of the field to assert.
* (optional) Value for the field, to assert that the field's value on the
* page doesn't match it. You may pass in NULL to skip checking the
* value, while still checking that the field doesn't exist.
* @param $message
* (optional) Message to display.
* @param $group
@ -3329,7 +3333,9 @@ class DrupalWebTestCase extends DrupalTestCase {
* @param $name
* Name of field to assert.
* @param $value
* Value of the field to assert.
* (optional) Value of the field to assert. You may pass in NULL (default)
* to skip checking the actual value, while still checking that the field
* exists.
* @param $message
* Message to display.
* @param $group
@ -3360,9 +3366,12 @@ class DrupalWebTestCase extends DrupalTestCase {
* @param $name
* Name of field to assert.
* @param $value
* Value of the field to assert.
* (optional) Value for the field, to assert that the field's value on the
* page doesn't match it. You may pass in NULL to skip checking the
* value, while still checking that the field doesn't exist. However, the
* default value ('') asserts that the field value is not an empty string.
* @param $message
* Message to display.
* (optional) Message to display.
* @param $group
* The group this message belongs to.
* @return
@ -3373,14 +3382,17 @@ class DrupalWebTestCase extends DrupalTestCase {
}
/**
* Asserts that a field exists in the current page with the given id and value.
* Asserts that a field exists in the current page with the given ID and value.
*
* @param $id
* Id of field to assert.
* ID of field to assert.
* @param $value
* Value of the field to assert.
* (optional) Value for the field to assert. You may pass in NULL to skip
* checking the value, while still checking that the field exists.
* However, the default value ('') asserts that the field value is an empty
* string.
* @param $message
* Message to display.
* (optional) Message to display.
* @param $group
* The group this message belongs to.
* @return
@ -3391,14 +3403,17 @@ class DrupalWebTestCase extends DrupalTestCase {
}
/**
* Asserts that a field does not exist with the given id and value.
* Asserts that a field does not exist with the given ID and value.
*
* @param $id
* Id of field to assert.
* ID of field to assert.
* @param $value
* Value of the field to assert.
* (optional) Value for the field, to assert that the field's value on the
* page doesn't match it. You may pass in NULL to skip checking the value,
* while still checking that the field doesn't exist. However, the default
* value ('') asserts that the field value is not an empty string.
* @param $message
* Message to display.
* (optional) Message to display.
* @param $group
* The group this message belongs to.
* @return
@ -3412,9 +3427,9 @@ class DrupalWebTestCase extends DrupalTestCase {
* Asserts that a checkbox field in the current page is checked.
*
* @param $id
* Id of field to assert.
* ID of field to assert.
* @param $message
* Message to display.
* (optional) Message to display.
* @return
* TRUE on pass, FALSE on fail.
*/
@ -3427,9 +3442,9 @@ class DrupalWebTestCase extends DrupalTestCase {
* Asserts that a checkbox field in the current page is not checked.
*
* @param $id
* Id of field to assert.
* ID of field to assert.
* @param $message
* Message to display.
* (optional) Message to display.
* @return
* TRUE on pass, FALSE on fail.
*/
@ -3442,11 +3457,11 @@ class DrupalWebTestCase extends DrupalTestCase {
* Asserts that a select option in the current page is checked.
*
* @param $id
* Id of select field to assert.
* ID of select field to assert.
* @param $option
* Option to assert.
* @param $message
* Message to display.
* (optional) Message to display.
* @return
* TRUE on pass, FALSE on fail.
*
@ -3461,11 +3476,11 @@ class DrupalWebTestCase extends DrupalTestCase {
* Asserts that a select option in the current page is not checked.
*
* @param $id
* Id of select field to assert.
* ID of select field to assert.
* @param $option
* Option to assert.
* @param $message
* Message to display.
* (optional) Message to display.
* @return
* TRUE on pass, FALSE on fail.
*/
@ -3475,12 +3490,12 @@ class DrupalWebTestCase extends DrupalTestCase {
}
/**
* Asserts that a field exists with the given name or id.
* Asserts that a field exists with the given name or ID.
*
* @param $field
* Name or id of field to assert.
* Name or ID of field to assert.
* @param $message
* Message to display.
* (optional) Message to display.
* @param $group
* The group this message belongs to.
* @return
@ -3491,12 +3506,12 @@ class DrupalWebTestCase extends DrupalTestCase {
}
/**
* Asserts that a field does not exist with the given name or id.
* Asserts that a field does not exist with the given name or ID.
*
* @param $field
* Name or id of field to assert.
* Name or ID of field to assert.
* @param $message
* Message to display.
* (optional) Message to display.
* @param $group
* The group this message belongs to.
* @return