diff options
author | webchick <webchick@24967.no-reply.drupal.org> | 2011-12-24 17:44:36 -0800 |
---|---|---|
committer | webchick <webchick@24967.no-reply.drupal.org> | 2011-12-24 17:44:36 -0800 |
commit | 227fd2c43d62fb2e318684ccbbc0cec3efd1fb29 (patch) | |
tree | 28f17d07210046576a84d933a4a9ff88f270b2de /modules/field_ui/field_ui.test | |
parent | 4747da6a10df847ed91098e3249c60bf99264d97 (diff) | |
download | brdo-227fd2c43d62fb2e318684ccbbc0cec3efd1fb29.tar.gz brdo-227fd2c43d62fb2e318684ccbbc0cec3efd1fb29.tar.bz2 |
Issue #1326638 by sven.lauer, jhodgdon, xjm: Clean up API docs for field_ui() module.
Diffstat (limited to 'modules/field_ui/field_ui.test')
-rw-r--r-- | modules/field_ui/field_ui.test | 45 |
1 files changed, 24 insertions, 21 deletions
diff --git a/modules/field_ui/field_ui.test b/modules/field_ui/field_ui.test index ea8727e5b..f1e770baa 100644 --- a/modules/field_ui/field_ui.test +++ b/modules/field_ui/field_ui.test @@ -6,7 +6,7 @@ */ /** - * Helper class for Field UI test classes. + * Provides common functionality for the Field UI test classes. */ class FieldUITestCase extends DrupalWebTestCase { @@ -34,10 +34,10 @@ class FieldUITestCase extends DrupalWebTestCase { } /** - * Create a new field through the Field UI. + * Creates a new field through the Field UI. * * @param $bundle_path - * Path of the 'Manage fields' page for the bundle. + * Admin path of the bundle that the new field is to be attached to. * @param $initial_edit * $edit parameter for drupalPost() on the first step ('Manage fields' * screen). @@ -74,10 +74,10 @@ class FieldUITestCase extends DrupalWebTestCase { } /** - * Add an existing field through the Field UI. + * Adds an existing field through the Field UI. * * @param $bundle_path - * Path of the 'Manage fields' page for the bundle. + * Admin path of the bundle that the field is to be attached to. * @param $initial_edit * $edit parameter for drupalPost() on the first step ('Manage fields' * screen). @@ -105,10 +105,10 @@ class FieldUITestCase extends DrupalWebTestCase { } /** - * Delete a field instance through the Field UI. + * Deletes a field instance through the Field UI. * * @param $bundle_path - * Path of the 'Manage fields' page for the bundle. + * Admin path of the bundle that the field instance is to be deleted from. * @param $field_name * The name of the field. * @param $label @@ -131,7 +131,7 @@ class FieldUITestCase extends DrupalWebTestCase { } /** - * Field UI tests for the 'Manage fields' screen. + * Tests the functionality of the 'Manage fields' screen. */ class FieldUIManageFieldsTestCase extends FieldUITestCase { public static function getInfo() { @@ -152,7 +152,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Main entry point for the field CRUD tests. + * Runs the field CRUD tests. * * In order to act on the same fields, and not create the fields over and over * again the following tests create, update and delete the same fields. @@ -165,7 +165,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Test the manage fields page. + * Tests the manage fields page. */ function manageFieldsPage() { $this->drupalGet('admin/structure/types/manage/' . $this->hyphen_type . '/fields'); @@ -190,7 +190,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Test adding a new field. + * Tests adding a new field. * * @todo Assert properties can bet set in the form and read back in $field and * $instances. @@ -212,7 +212,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Test editing an existing field. + * Tests editing an existing field. */ function updateField() { // Go to the field edit page. @@ -235,7 +235,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Test adding an existing field in another content type. + * Tests adding an existing field in another content type. */ function addExistingField() { // Check "Add existing field" appears. @@ -256,7 +256,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Assert the field settings. + * Asserts field settings are as expected. * * @param $bundle * The bundle name for the instance. @@ -378,7 +378,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Test that Field UI respects the 'no_ui' option in hook_field_info(). + * Tests that Field UI respects the 'no_ui' option in hook_field_info(). */ function testHiddenFields() { $bundle_path = 'admin/structure/types/manage/' . $this->hyphen_type . '/fields/'; @@ -429,7 +429,7 @@ class FieldUIManageFieldsTestCase extends FieldUITestCase { } /** - * Field UI tests for the 'Manage display' screens. + * Tests the functionality of the 'Manage display' screens. */ class FieldUIManageDisplayTestCase extends FieldUITestCase { public static function getInfo() { @@ -445,7 +445,7 @@ class FieldUIManageDisplayTestCase extends FieldUITestCase { } /** - * Test formatter formatter settings. + * Tests formatter settings. */ function testFormatterUI() { $manage_fields = 'admin/structure/types/manage/' . $this->hyphen_type; @@ -493,7 +493,7 @@ class FieldUIManageDisplayTestCase extends FieldUITestCase { } /** - * Test switching view modes to use custom or 'default' settings'. + * Tests switching view modes to use custom or 'default' settings'. */ function testViewModeCustom() { // Create a field, and a node with some data for the field. @@ -565,7 +565,7 @@ class FieldUIManageDisplayTestCase extends FieldUITestCase { } /** - * Pass if the text is found in the rendered node in a given view mode. + * Asserts that a string is found in the rendered node in a view mode. * * @param $node * The node. @@ -584,7 +584,7 @@ class FieldUIManageDisplayTestCase extends FieldUITestCase { } /** - * Pass if the text is node found in the rendered node in a given view mode. + * Asserts that a string is not found in the rendered node in a view mode. * * @param $node * The node. @@ -602,7 +602,10 @@ class FieldUIManageDisplayTestCase extends FieldUITestCase { } /** - * Helper for assertNodeViewText and assertNodeViewNoText. + * Asserts that a string is (not) found in the rendered nodein a view mode. + * + * This helper function is used by assertNodeViewText() and + * assertNodeViewNoText(). * * @param $node * The node. |