From c403b16006428696815d3fc8fc9640c976d80e13 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Wed, 1 Apr 2009 19:56:34 +0000
Subject: - Patch #397800 by JamesAn: cleaned up some PHPdocs.

---
 modules/aggregator/aggregator.test | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

(limited to 'modules/aggregator/aggregator.test')

diff --git a/modules/aggregator/aggregator.test b/modules/aggregator/aggregator.test
index 6d3305c52..058af286c 100644
--- a/modules/aggregator/aggregator.test
+++ b/modules/aggregator/aggregator.test
@@ -1,6 +1,11 @@
 <?php
 // $Id$
 
+/**
+ * @file
+ * Creates tests for aggregator module.
+ */
+
 class AggregatorTestCase extends DrupalWebTestCase {
   private static $prefix = 'simpletest_aggregator_';
 
@@ -33,7 +38,8 @@ class AggregatorTestCase extends DrupalWebTestCase {
   /**
    * Delete an aggregator feed.
    *
-   * @param object $feed Feed object representing the feed.
+   * @param $feed
+   *   Feed object representing the feed.
    */
   function deleteFeed($feed) {
     $this->drupalPost('admin/content/aggregator/edit/feed/' . $feed->fid, array(), t('Delete'));
@@ -103,7 +109,8 @@ class AggregatorTestCase extends DrupalWebTestCase {
   /**
    * Confirm item removal from a feed.
    *
-   * @param object $feed Feed object representing the feed.
+   * @param $feed
+   *   Feed object representing the feed.
    */
   function removeFeedItems($feed) {
     $this->drupalPost('admin/content/aggregator/remove/' . $feed->fid, array(), t('Remove items'));
@@ -129,7 +136,8 @@ class AggregatorTestCase extends DrupalWebTestCase {
   /**
    * Pull feed categories from aggregator_category_feed table.
    *
-   * @param object $feed Feed object representing the feed.
+   * @param $feed
+   *   Feed object representing the feed.
    */
   function getFeedCategories($feed) {
     // add the categories to the feed so we can use them
@@ -142,9 +150,12 @@ class AggregatorTestCase extends DrupalWebTestCase {
   /**
    * Check if the feed name and url is unique.
    *
-   * @param string $feed_name Feed name to check.
-   * @param string $feed_url Feed url to check.
-   * @return boolean Feed is unique.
+   * @param $feed_name
+   *   String containing the feed name to check.
+   * @param $feed_url
+   *   String containing the feed url to check.
+   * @return
+   *   TRUE if feed is unique.
    */
   function uniqueFeed($feed_name, $feed_url) {
     $result = db_query("SELECT COUNT(*) FROM {aggregator_feed} WHERE title = :title AND url = :url", array(':title' => $feed_name, ':url' => $feed_url))->fetchField();
-- 
cgit v1.2.3