From 5ff571980011572efa144fed47d0f1290f2ef0e0 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Sat, 27 Feb 2010 21:09:15 +0000 Subject: [PATCH] * Fixed some doxygen warnings * Documented a bit --- includes/HistoryBlob.php | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/includes/HistoryBlob.php b/includes/HistoryBlob.php index 664ceb4f06..83360594cf 100644 --- a/includes/HistoryBlob.php +++ b/includes/HistoryBlob.php @@ -11,12 +11,15 @@ interface HistoryBlob * Adds an item of text, returns a stub object which points to the item. * You must call setLocation() on the stub object before storing it to the * database - * Returns the key for getItem() + * + * @return String: the key for getItem() */ public function addItem( $text ); /** * Get item by key, or false if the key is not present + * + * @return String or false */ public function getItem( $key ); @@ -32,6 +35,8 @@ interface HistoryBlob /** * Get default text. This is called from Revision::getRevisionText() + * + * @return String */ function getText(); } @@ -149,8 +154,8 @@ class HistoryBlobStub { var $mOldId, $mHash, $mRef; /** - * @param string $hash The content hash of the text - * @param integer $oldid The old_id for the CGZ object + * @param $hash Strng: the content hash of the text + * @param $oldid Integer: the old_id for the CGZ object */ function HistoryBlobStub( $hash = '', $oldid = 0 ) { $this->mHash = $hash; @@ -246,7 +251,7 @@ class HistoryBlobCurStub { var $mCurId; /** - * @param integer $curid The cur_id pointed to + * @param $curid Integer: the cur_id pointed to */ function HistoryBlobCurStub( $curid = 0 ) { $this->mCurId = $curid; -- 2.20.1