@@ -63,7 +63,7 @@ |
||
63 | 63 | * |
64 | 64 | * @access public |
65 | 65 | * @param string $dir The dir to be used as temp dir |
66 | - * @return true if given dir is valid, false otherwise |
|
66 | + * @return boolean if given dir is valid, false otherwise |
|
67 | 67 | */ |
68 | 68 | function setTempDir($dir) |
69 | 69 | { |
@@ -65,7 +65,7 @@ discard block |
||
65 | 65 | * |
66 | 66 | * @access public |
67 | 67 | * @param string $dir The dir to be used as temp dir |
68 | - * @return true if given dir is valid, false otherwise |
|
68 | + * @return boolean if given dir is valid, false otherwise |
|
69 | 69 | */ |
70 | 70 | function setTempDir($dir) |
71 | 71 | { |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | * |
143 | 143 | * @access private |
144 | 144 | * @param array $raList Reference to an array of PPS's |
145 | - * @return array The array of numbers |
|
145 | + * @return double[] The array of numbers |
|
146 | 146 | */ |
147 | 147 | function _calcSize(&$raList) |
148 | 148 | { |
@@ -180,7 +180,7 @@ discard block |
||
180 | 180 | * @access private |
181 | 181 | * @param integer $i2 The argument |
182 | 182 | * @see save() |
183 | - * @return integer |
|
183 | + * @return double |
|
184 | 184 | */ |
185 | 185 | function _adjust2($i2) |
186 | 186 | { |
@@ -592,7 +592,7 @@ discard block |
||
592 | 592 | * |
593 | 593 | * @param integer $index Offset to get pageID for |
594 | 594 | * |
595 | - * @return integer PageID for given offset |
|
595 | + * @return PEAR_Error PageID for given offset |
|
596 | 596 | * @access public |
597 | 597 | */ |
598 | 598 | function getPageIdByOffset($index) |
@@ -612,7 +612,7 @@ discard block |
||
612 | 612 | * |
613 | 613 | * @param integer $pageID PageID to get offsets for |
614 | 614 | * |
615 | - * @return array First and last offsets |
|
615 | + * @return integer[] First and last offsets |
|
616 | 616 | * @access public |
617 | 617 | */ |
618 | 618 | function getOffsetByPageId($pageID = null) |
@@ -639,7 +639,7 @@ discard block |
||
639 | 639 | * |
640 | 640 | * @param integer $pageID PageID to get offsets for |
641 | 641 | * |
642 | - * @return array First and last offsets |
|
642 | + * @return PEAR_Error First and last offsets |
|
643 | 643 | * @access public |
644 | 644 | */ |
645 | 645 | function getPageRangeByPageId($pageID = null) |
@@ -668,7 +668,7 @@ discard block |
||
668 | 668 | * @param string $next_html HTML to put inside the next link |
669 | 669 | * [deprecated: use the factory instead] |
670 | 670 | * |
671 | - * @return array back/next/first/last and page links |
|
671 | + * @return PEAR_Error back/next/first/last and page links |
|
672 | 672 | * @access public |
673 | 673 | */ |
674 | 674 | function getLinks($pageID=null, $next_html='') |
@@ -698,7 +698,7 @@ discard block |
||
698 | 698 | * Returns next page ID. If current page is last page |
699 | 699 | * this function returns FALSE |
700 | 700 | * |
701 | - * @return mixed Next page ID or false |
|
701 | + * @return integer Next page ID or false |
|
702 | 702 | * @access public |
703 | 703 | */ |
704 | 704 | function getNextPageID() |
@@ -713,7 +713,7 @@ discard block |
||
713 | 713 | * Returns previous page ID. If current page is first page |
714 | 714 | * this function returns FALSE |
715 | 715 | * |
716 | - * @return mixed Previous page ID or false |
|
716 | + * @return integer Previous page ID or false |
|
717 | 717 | * @access public |
718 | 718 | */ |
719 | 719 | function getPreviousPageID() |
@@ -994,7 +994,7 @@ discard block |
||
994 | 994 | * |
995 | 995 | * @param string $string the pattern to check |
996 | 996 | * |
997 | - * @return boolean |
|
997 | + * @return integer |
|
998 | 998 | * @access private |
999 | 999 | */ |
1000 | 1000 | function _isRegexp($string) { |
@@ -1136,7 +1136,7 @@ discard block |
||
1136 | 1136 | * |
1137 | 1137 | * @param string $url URL to use in the link [deprecated: use the factory instead] |
1138 | 1138 | * |
1139 | - * @return string Links |
|
1139 | + * @return PEAR_Error Links |
|
1140 | 1140 | * @access private |
1141 | 1141 | */ |
1142 | 1142 | function _getPageLinks($url='') |
@@ -55,7 +55,8 @@ |
||
55 | 55 | /** |
56 | 56 | * Constructor |
57 | 57 | * |
58 | - * @param object &$pager Pager instance |
|
58 | + * @param object &$pager Pager instance |
|
59 | + * @param Pager_Common $pager |
|
59 | 60 | */ |
60 | 61 | function Pager_HtmlWidgets(&$pager) |
61 | 62 | { |
@@ -107,7 +107,7 @@ |
||
107 | 107 | * |
108 | 108 | * @param integer $pageid PageID to get offsets for |
109 | 109 | * |
110 | - * @return array First and last offsets |
|
110 | + * @return integer[] First and last offsets |
|
111 | 111 | * @access public |
112 | 112 | */ |
113 | 113 | function getPageRangeByPageId($pageid = null) |
@@ -490,7 +490,7 @@ discard block |
||
490 | 490 | * PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, |
491 | 491 | * PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION. |
492 | 492 | * |
493 | - * @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter |
|
493 | + * @param integer|null $options If $mode is PEAR_ERROR_TRIGGER, this parameter |
|
494 | 494 | * specifies the PHP-internal error level (one of |
495 | 495 | * E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR). |
496 | 496 | * If $mode is PEAR_ERROR_CALLBACK, this |
@@ -581,6 +581,7 @@ discard block |
||
581 | 581 | * message, code and userinfo are enough. |
582 | 582 | * |
583 | 583 | * @param string $message |
584 | + * @param integer $code |
|
584 | 585 | * |
585 | 586 | */ |
586 | 587 | function &throwError($message = null, |
@@ -864,7 +865,7 @@ discard block |
||
864 | 865 | * PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER, |
865 | 866 | * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION |
866 | 867 | * |
867 | - * @param mixed $options (optional) error level, _OR_ in the case of |
|
868 | + * @param integer $options (optional) error level, _OR_ in the case of |
|
868 | 869 | * PEAR_ERROR_CALLBACK, the callback function or object/method |
869 | 870 | * tuple. |
870 | 871 | * |
@@ -147,6 +147,7 @@ discard block |
||
147 | 147 | * the two files do not match, and likewise that the last lines do not |
148 | 148 | * match. The caller must trim matching lines from the beginning and end |
149 | 149 | * of the portions it is going to specify. |
150 | + * @param double $nchunks |
|
150 | 151 | */ |
151 | 152 | function _diag ($xoff, $xlim, $yoff, $ylim, $nchunks) |
152 | 153 | { |
@@ -267,6 +268,10 @@ discard block |
||
267 | 268 | * |
268 | 269 | * Note that XLIM, YLIM are exclusive bounds. All line numbers are |
269 | 270 | * origin-0 and discarded lines are not counted. |
271 | + * @param integer $xoff |
|
272 | + * @param integer $xlim |
|
273 | + * @param integer $yoff |
|
274 | + * @param integer $ylim |
|
270 | 275 | */ |
271 | 276 | function _compareseq ($xoff, $xlim, $yoff, $ylim) |
272 | 277 | { |
@@ -143,6 +143,12 @@ discard block |
||
143 | 143 | return $output . $this->_endDiff(); |
144 | 144 | } |
145 | 145 | |
146 | + /** |
|
147 | + * @param integer $xbeg |
|
148 | + * @param integer $xlen |
|
149 | + * @param integer $ybeg |
|
150 | + * @param integer $ylen |
|
151 | + */ |
|
146 | 152 | function _block($xbeg, $xlen, $ybeg, $ylen, &$edits) |
147 | 153 | { |
148 | 154 | $output = $this->_startBlock($this->_blockHeader($xbeg, $xlen, $ybeg, $ylen)); |
@@ -199,6 +205,9 @@ discard block |
||
199 | 205 | return $xbeg . ($xlen ? ($ylen ? 'c' : 'd') : 'a') . $ybeg; |
200 | 206 | } |
201 | 207 | |
208 | + /** |
|
209 | + * @param string $header |
|
210 | + */ |
|
202 | 211 | function _startBlock($header) |
203 | 212 | { |
204 | 213 | return $header . "\n"; |
@@ -74,6 +74,9 @@ discard block |
||
74 | 74 | return $header; |
75 | 75 | } |
76 | 76 | |
77 | + /** |
|
78 | + * @param string[] $lines |
|
79 | + */ |
|
77 | 80 | function _lines($lines, $prefix = ' ', $encode = true) |
78 | 81 | { |
79 | 82 | if ($encode) { |
@@ -141,6 +144,9 @@ discard block |
||
141 | 144 | return str_replace($nl, "\n", $renderer->render($diff)) . "\n"; |
142 | 145 | } |
143 | 146 | |
147 | + /** |
|
148 | + * @param string $string |
|
149 | + */ |
|
144 | 150 | function _splitOnWords($string, $newlineEscape = "\n") |
145 | 151 | { |
146 | 152 | // Ignore \0; otherwise the while loop will never finish. |