| Index: trunk/phase3/includes/HistoryBlob.php |
| — | — | @@ -11,12 +11,15 @@ |
| 12 | 12 | * Adds an item of text, returns a stub object which points to the item. |
| 13 | 13 | * You must call setLocation() on the stub object before storing it to the |
| 14 | 14 | * database |
| 15 | | - * Returns the key for getItem() |
| | 15 | + * |
| | 16 | + * @return String: the key for getItem() |
| 16 | 17 | */ |
| 17 | 18 | public function addItem( $text ); |
| 18 | 19 | |
| 19 | 20 | /** |
| 20 | 21 | * Get item by key, or false if the key is not present |
| | 22 | + * |
| | 23 | + * @return String or false |
| 21 | 24 | */ |
| 22 | 25 | public function getItem( $key ); |
| 23 | 26 | |
| — | — | @@ -32,6 +35,8 @@ |
| 33 | 36 | |
| 34 | 37 | /** |
| 35 | 38 | * Get default text. This is called from Revision::getRevisionText() |
| | 39 | + * |
| | 40 | + * @return String |
| 36 | 41 | */ |
| 37 | 42 | function getText(); |
| 38 | 43 | } |
| — | — | @@ -149,8 +154,8 @@ |
| 150 | 155 | var $mOldId, $mHash, $mRef; |
| 151 | 156 | |
| 152 | 157 | /** |
| 153 | | - * @param string $hash The content hash of the text |
| 154 | | - * @param integer $oldid The old_id for the CGZ object |
| | 158 | + * @param $hash Strng: the content hash of the text |
| | 159 | + * @param $oldid Integer: the old_id for the CGZ object |
| 155 | 160 | */ |
| 156 | 161 | function HistoryBlobStub( $hash = '', $oldid = 0 ) { |
| 157 | 162 | $this->mHash = $hash; |
| — | — | @@ -246,7 +251,7 @@ |
| 247 | 252 | var $mCurId; |
| 248 | 253 | |
| 249 | 254 | /** |
| 250 | | - * @param integer $curid The cur_id pointed to |
| | 255 | + * @param $curid Integer: the cur_id pointed to |
| 251 | 256 | */ |
| 252 | 257 | function HistoryBlobCurStub( $curid = 0 ) { |
| 253 | 258 | $this->mCurId = $curid; |