From 6b3f1d476ea0d1be46b3e4a7df6983320865303b Mon Sep 17 00:00:00 2001
From: cweiske <cweiske@b3834d28-1941-0410-a4f8-b48e95affb8f>
Date: Tue, 28 Sep 2010 22:10:53 +0000
Subject: update docblocks

git-svn-id: https://semanticscuttle.svn.sourceforge.net/svnroot/semanticscuttle/trunk@766 b3834d28-1941-0410-a4f8-b48e95affb8f
---
 tests/TestBaseApi.php | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'tests/TestBaseApi.php')

diff --git a/tests/TestBaseApi.php b/tests/TestBaseApi.php
index 645ead9..eb1457f 100644
--- a/tests/TestBaseApi.php
+++ b/tests/TestBaseApi.php
@@ -29,6 +29,16 @@ class TestBaseApi extends TestBase
     protected $url;
     protected $urlPart = null;
 
+    /**
+     * @var SemanticScuttle_Service_User
+     */
+    protected $us;
+
+    /**
+     * @var SemanticScuttle_Service_Bookmark
+     */
+    protected $bs;
+
 
 
     protected function setUp()
@@ -52,11 +62,14 @@ class TestBaseApi extends TestBase
 
 
     /**
-     * Gets a HTTP request object
+     * Gets a HTTP request object.
+     * Uses $this->url plus $urlSuffix as request URL.
      *
      * @param string $urlSuffix Suffix for the URL
      *
      * @return HTTP_Request2 HTTP request object
+     *
+     * @uses $url
      */
     protected function getRequest($urlSuffix = null)
     {
@@ -71,13 +84,17 @@ class TestBaseApi extends TestBase
 
 
     /**
-     * Gets a HTTP request object
+     * Creates a user and a HTTP request object and prepares
+     * the request object with authentication details, so that
+     * the user is logged in.
      *
      * @param string $urlSuffix Suffix for the URL
      * @param mixed  $auth      If user authentication is needed (true/false)
      *                          or array with username and password
      *
      * @return array(HTTP_Request2, integer) HTTP request object and user id
+     *
+     * @uses getRequest()
      */
     protected function getAuthRequest($urlSuffix = null, $auth = true)
     {
-- 
cgit v1.2.3