@@ -34,7 +34,7 @@ discard block |
||
34 | 34 | * </code> |
35 | 35 | * |
36 | 36 | * @param string $css Stylesheet definitions as string |
37 | - * @param array|string $options Array or comma speperated list of options: |
|
37 | + * @param string $options Array or comma speperated list of options: |
|
38 | 38 | * |
39 | 39 | * - remove-last-semicolon: Removes the last semicolon in |
40 | 40 | * the style definition of an element (activated by default). |
@@ -120,8 +120,7 @@ discard block |
||
120 | 120 | * $css_string = cssmin::toString($css_structure); |
121 | 121 | * </code> |
122 | 122 | * |
123 | - * @param array $css |
|
124 | - * @return array |
|
123 | + * @return string |
|
125 | 124 | */ |
126 | 125 | public static function toString(array $array) |
127 | 126 | { |
@@ -69,6 +69,9 @@ |
||
69 | 69 | } |
70 | 70 | } |
71 | 71 | |
72 | + /** |
|
73 | + * @param string $file |
|
74 | + */ |
|
72 | 75 | private function loadMetaHelper($dir, $file) { |
73 | 76 | if(file_exists("cache/sprites/{$dir}/{$file}.meta.php")) { |
74 | 77 | $sprites = array(); |
@@ -458,7 +458,7 @@ discard block |
||
458 | 458 | /** |
459 | 459 | * Return array of all valid fields that can be specified in the themedef.php file |
460 | 460 | * |
461 | - * @return array |
|
461 | + * @return string[] |
|
462 | 462 | */ |
463 | 463 | public static function getThemeDefFields() |
464 | 464 | { |
@@ -698,7 +698,7 @@ discard block |
||
698 | 698 | /** |
699 | 699 | * Returns an image tag for the given image. |
700 | 700 | * |
701 | - * @param string $image image name |
|
701 | + * @param string $imageName image name |
|
702 | 702 | * @param string $other_attributes optional, other attributes to add to the image tag, not cached |
703 | 703 | * @param string $width optional, defaults to the actual image's width |
704 | 704 | * @param string $height optional, defaults to the actual image's height |
@@ -817,6 +817,8 @@ discard block |
||
817 | 817 | * @param string class The md5 id used in the CSS sprites class |
818 | 818 | * @param string attr optional, list of additional html attributes |
819 | 819 | * @param string title optional, the title (equivalent to alt on img) |
820 | + * @param string $attr |
|
821 | + * @param string $title |
|
820 | 822 | * @return string HTML span tag |
821 | 823 | */ |
822 | 824 | public function getSprite($class, $attr, $title) { |
@@ -113,6 +113,7 @@ discard block |
||
113 | 113 | /** |
114 | 114 | * Implodes the text for a bunch of actions (such as links, forms, |
115 | 115 | * into a HTML list and returns the text. |
116 | + * @param string[] $actions |
|
116 | 117 | */ |
117 | 118 | function xhprof_render_actions($actions) { |
118 | 119 | $out = array(); |
@@ -142,8 +143,6 @@ discard block |
||
142 | 143 | * @param raw-str $onmouseover |
143 | 144 | * @param raw-str $onmouseout |
144 | 145 | * @param raw-str $onmousedown |
145 | - * @param raw-str $dir |
|
146 | - * @param raw-str $rel |
|
147 | 146 | */ |
148 | 147 | function xhprof_render_link($content, $href, $class='', $id='', $title='', |
149 | 148 | $target='', |
@@ -589,6 +588,7 @@ discard block |
||
589 | 588 | * For instance, negative numbers in diff reports comparing two runs (run1 & run2) |
590 | 589 | * represent improvement from run1 to run2. We use green to display those deltas, |
591 | 590 | * and red for regression deltas. |
591 | + * @param boolean $bold |
|
592 | 592 | */ |
593 | 593 | function get_print_class($num, $bold) { |
594 | 594 | global $vbar; |
@@ -712,6 +712,7 @@ discard block |
||
712 | 712 | * Print non-hierarchical (flat-view) of profiler data. |
713 | 713 | * |
714 | 714 | * @author Kannan |
715 | + * @param integer $limit |
|
715 | 716 | */ |
716 | 717 | function print_flat_data($url_params, $title, $flat_data, $sort, $run1, $run2, $limit) { |
717 | 718 | |
@@ -778,6 +779,7 @@ discard block |
||
778 | 779 | * Generates a tabular report for all functions. This is the top-level report. |
779 | 780 | * |
780 | 781 | * @author Kannan |
782 | + * @param integer $run2 |
|
781 | 783 | */ |
782 | 784 | function full_report($url_params, $symbol_tab, $sort, $run1, $run2) { |
783 | 785 | global $vwbar; |
@@ -922,6 +924,7 @@ discard block |
||
922 | 924 | |
923 | 925 | /** |
924 | 926 | * Return attribute names and values to be used by javascript tooltip. |
927 | + * @param string $type |
|
925 | 928 | */ |
926 | 929 | function get_tooltip_attributes($type, $metric) { |
927 | 930 | return "type='$type' metric='$metric'"; |
@@ -960,6 +963,10 @@ discard block |
||
960 | 963 | } |
961 | 964 | } |
962 | 965 | |
966 | +/** |
|
967 | + * @param boolean $parent |
|
968 | + * @param integer $run2 |
|
969 | + */ |
|
963 | 970 | function print_pc_array($url_params, $results, $base_ct, $base_info, $parent, |
964 | 971 | $run1, $run2) { |
965 | 972 | global $base_path; |
@@ -1299,6 +1306,8 @@ discard block |
||
1299 | 1306 | * Generate the profiler report for a single run. |
1300 | 1307 | * |
1301 | 1308 | * @author Kannan |
1309 | + * @param string $rep_symbol |
|
1310 | + * @param string $run |
|
1302 | 1311 | */ |
1303 | 1312 | function profiler_single_run_report ($url_params, |
1304 | 1313 | $xhprof_data, |
@@ -1319,6 +1328,9 @@ discard block |
||
1319 | 1328 | * Generate the profiler report for diff mode (delta between two runs). |
1320 | 1329 | * |
1321 | 1330 | * @author Kannan |
1331 | + * @param string $rep_symbol |
|
1332 | + * @param string $run1 |
|
1333 | + * @param string $run2 |
|
1322 | 1334 | */ |
1323 | 1335 | function profiler_diff_report($url_params, |
1324 | 1336 | $xhprof_data1, |
@@ -38,6 +38,8 @@ discard block |
||
38 | 38 | * |
39 | 39 | * @param string HTTP header name, like 'Location' |
40 | 40 | * @param string HTTP header value, like 'http://www.example.com/' |
41 | + * @param string $name |
|
42 | + * @param string $value |
|
41 | 43 | * |
42 | 44 | */ |
43 | 45 | function xhprof_http_header($name, $value) { |
@@ -58,6 +60,7 @@ discard block |
||
58 | 60 | * Genearte and send MIME header for the output image to client browser. |
59 | 61 | * |
60 | 62 | * @author cjiang |
63 | + * @param integer $length |
|
61 | 64 | */ |
62 | 65 | function xhprof_generate_mime_header($type, $length) { |
63 | 66 | switch ($type) { |
@@ -93,6 +96,7 @@ discard block |
||
93 | 96 | * @param dot_script, string, the script for DOT to generate the image. |
94 | 97 | * @param type, one of the supported image types, see |
95 | 98 | * $xhprof_legal_image_types. |
99 | + * @param string $dot_script |
|
96 | 100 | * @returns, binary content of the generated image on success. empty string on |
97 | 101 | * failure. |
98 | 102 | * |
@@ -706,6 +706,7 @@ discard block |
||
706 | 706 | * Set one key in an array and return the array |
707 | 707 | * |
708 | 708 | * @author Kannan |
709 | + * @param string $k |
|
709 | 710 | */ |
710 | 711 | function xhprof_array_set($arr, $k, $v) { |
711 | 712 | $arr[$k] = $v; |
@@ -716,6 +717,7 @@ discard block |
||
716 | 717 | * Removes/unsets one key in an array and return the array |
717 | 718 | * |
718 | 719 | * @author Kannan |
720 | + * @param string $k |
|
719 | 721 | */ |
720 | 722 | function xhprof_array_unset($arr, $k) { |
721 | 723 | unset($arr[$k]); |
@@ -739,6 +741,7 @@ discard block |
||
739 | 741 | * @param string name of the URL query string param |
740 | 742 | * |
741 | 743 | * @author Kannan |
744 | + * @return string |
|
742 | 745 | */ |
743 | 746 | function xhprof_get_param_helper($param) { |
744 | 747 | $val = null; |
@@ -85,6 +85,9 @@ discard block |
||
85 | 85 | return $file; |
86 | 86 | } |
87 | 87 | |
88 | + /** |
|
89 | + * @param string $dir |
|
90 | + */ |
|
88 | 91 | public function __construct($dir = null) { |
89 | 92 | |
90 | 93 | // if user hasn't passed a directory location, |
@@ -123,6 +126,9 @@ discard block |
||
123 | 126 | return unserialize($contents); |
124 | 127 | } |
125 | 128 | |
129 | + /** |
|
130 | + * @param string $type |
|
131 | + */ |
|
126 | 132 | public function save_run($xhprof_data, $type, $run_id = null) { |
127 | 133 | |
128 | 134 | // Use PHP serialize function to store the XHProf's |
@@ -48,6 +48,10 @@ |
||
48 | 48 | var $tabs; |
49 | 49 | var $current_key; |
50 | 50 | |
51 | + /** |
|
52 | + * @param string $current_key |
|
53 | + * @param string $jscallback |
|
54 | + */ |
|
51 | 55 | function SugarWidgetTabs(&$tabs,$current_key,$jscallback) |
52 | 56 | { |
53 | 57 | $this->tabs = $tabs; |
@@ -346,7 +346,7 @@ discard block |
||
346 | 346 | /** |
347 | 347 | * Encode a string to be used for CODE 39 Extended mode. |
348 | 348 | * @param string $code code to represent. |
349 | - * @return encoded string. |
|
349 | + * @return false|string string. |
|
350 | 350 | * @access protected |
351 | 351 | */ |
352 | 352 | protected function encode_code39_ext($code) { |
@@ -397,7 +397,7 @@ discard block |
||
397 | 397 | /** |
398 | 398 | * Calculate CODE 39 checksum (modulo 43). |
399 | 399 | * @param string $code code to represent. |
400 | - * @return char checksum. |
|
400 | + * @return string checksum. |
|
401 | 401 | * @access protected |
402 | 402 | */ |
403 | 403 | protected function checksum_code39($code) { |
@@ -420,7 +420,6 @@ discard block |
||
420 | 420 | * CODE 93 - USS-93 |
421 | 421 | * Compact code similar to Code 39 |
422 | 422 | * @param string $code code to represent. |
423 | - * @param boolean $checksum if true add a checksum to the code |
|
424 | 423 | * @return array barcode representation. |
425 | 424 | * @access protected |
426 | 425 | */ |
@@ -1009,7 +1008,7 @@ discard block |
||
1009 | 1008 | * UPC-A: Universal product code seen on almost all retail products in the USA and Canada |
1010 | 1009 | * UPC-E: Short version of UPC symbol |
1011 | 1010 | * @param string $code code to represent. |
1012 | - * @param string $len barcode type: 6 = UPC-E, 8 = EAN8, 13 = EAN13, 12 = UPC-A |
|
1011 | + * @param integer $len barcode type: 6 = UPC-E, 8 = EAN8, 13 = EAN13, 12 = UPC-A |
|
1013 | 1012 | * @return array barcode representation. |
1014 | 1013 | * @access protected |
1015 | 1014 | */ |
@@ -1202,7 +1201,7 @@ discard block |
||
1202 | 1201 | * 2-Digit Ext.: Used to indicate magazines and newspaper issue numbers |
1203 | 1202 | * 5-Digit Ext.: Used to mark suggested retail price of books |
1204 | 1203 | * @param string $code code to represent. |
1205 | - * @param string $len barcode type: 2 = 2-Digit, 5 = 5-Digit |
|
1204 | + * @param integer $len barcode type: 2 = 2-Digit, 5 = 5-Digit |
|
1206 | 1205 | * @return array barcode representation. |
1207 | 1206 | * @access protected |
1208 | 1207 | */ |