diff options
author | webchick <webchick@24967.no-reply.drupal.org> | 2011-12-22 01:36:41 -0800 |
---|---|---|
committer | webchick <webchick@24967.no-reply.drupal.org> | 2011-12-22 01:36:41 -0800 |
commit | db0b9c89fc9c30d98a6b49e8a60de41de9d4fac9 (patch) | |
tree | cc88d56b3c75c4839261dd1fd26091ecc0bfe75b /modules/help/help.test | |
parent | 06d408fae3a9564916436933da89293e1ab0b904 (diff) | |
download | brdo-db0b9c89fc9c30d98a6b49e8a60de41de9d4fac9.tar.gz brdo-db0b9c89fc9c30d98a6b49e8a60de41de9d4fac9.tar.bz2 |
Issue #1319904 by rc_100, xjm, jhodgdon: Clean up API docs for help module.
Diffstat (limited to 'modules/help/help.test')
-rw-r--r-- | modules/help/help.test | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/modules/help/help.test b/modules/help/help.test index 73b4dedc8..e72aa4a0e 100644 --- a/modules/help/help.test +++ b/modules/help/help.test @@ -5,8 +5,18 @@ * Tests for help.module. */ +/** + * Tests help display and user access for all modules implementing help. + */ class HelpTestCase extends DrupalWebTestCase { + /** + * The admin user that will be created. + */ protected $big_user; + + /** + * The anonymous user that will be created. + */ protected $any_user; public static function getInfo() { @@ -17,9 +27,6 @@ class HelpTestCase extends DrupalWebTestCase { ); } - /** - * Enable modules and create users with specific permissions. - */ function setUp() { parent::setUp('blog', 'poll'); @@ -31,7 +38,7 @@ class HelpTestCase extends DrupalWebTestCase { } /** - * Login users, create dblog events, and test dblog functionality through the admin and user interfaces. + * Logs in users, creates dblog events, and tests dblog functionality. */ function testHelp() { // Login the admin user. @@ -60,9 +67,10 @@ class HelpTestCase extends DrupalWebTestCase { } /** - * Verify the logged in user has the desired access to the various help nodes and the nodes display help. + * Verifies the logged in user has access to the various help nodes. * - * @param integer $response HTTP response code. + * @param integer $response + * An HTTP response code. */ protected function verifyHelp($response = 200) { foreach ($this->modules as $module => $name) { @@ -77,9 +85,10 @@ class HelpTestCase extends DrupalWebTestCase { } /** - * Get list of enabled modules that implement hook_help(). + * Gets the list of enabled modules that implement hook_help(). * - * @return array Enabled modules. + * @return array + * A list of enabled modules. */ protected function getModuleList() { $this->modules = array(); @@ -94,9 +103,12 @@ class HelpTestCase extends DrupalWebTestCase { } /** - * Tests module without help to verify it is not listed in help page. + * Tests a module without help to verify it is not listed in the help page. */ class NoHelpTestCase extends DrupalWebTestCase { + /** + * The user who will be created. + */ protected $big_user; public static function getInfo() { @@ -114,7 +126,7 @@ class NoHelpTestCase extends DrupalWebTestCase { } /** - * Ensure modules not implementing help do not appear on admin/help. + * Ensures modules not implementing help do not appear on admin/help. */ function testMainPageNoHelp() { $this->drupalLogin($this->big_user); |