| Index: trunk/phase3/includes/media/MediaTransformOutput.php |
| — | — | @@ -34,7 +34,7 @@ |
| 35 | 35 | } |
| 36 | 36 | |
| 37 | 37 | /** |
| 38 | | - * @return string Destination file path (local filesystem) |
| | 38 | + * @return String: destination file path (local filesystem) |
| 39 | 39 | */ |
| 40 | 40 | function getPath() { |
| 41 | 41 | return $this->path; |
| — | — | @@ -43,7 +43,7 @@ |
| 44 | 44 | /** |
| 45 | 45 | * Fetch HTML for this transform output |
| 46 | 46 | * |
| 47 | | - * @param array $options Associative array of options. Boolean options |
| | 47 | + * @param $options Associative array of options. Boolean options |
| 48 | 48 | * should be indicated with a value of true for true, and false or |
| 49 | 49 | * absent for false. |
| 50 | 50 | * |
| — | — | @@ -103,9 +103,14 @@ |
| 104 | 104 | * @ingroup Media |
| 105 | 105 | */ |
| 106 | 106 | class ThumbnailImage extends MediaTransformOutput { |
| | 107 | + |
| 107 | 108 | /** |
| 108 | | - * @param string $path Filesystem path to the thumb |
| 109 | | - * @param string $url URL path to the thumb |
| | 109 | + * @param $file File object |
| | 110 | + * @param $url String: URL path to the thumb |
| | 111 | + * @param $width Integer: file's width |
| | 112 | + * @param $height Integer: file's height |
| | 113 | + * @param $path String: filesystem path to the thumb |
| | 114 | + * @param $page Integer: page number, for multipage files |
| 110 | 115 | * @private |
| 111 | 116 | */ |
| 112 | 117 | function ThumbnailImage( $file, $url, $width, $height, $path = false, $page = false ) { |
| — | — | @@ -124,7 +129,7 @@ |
| 125 | 130 | * Return HTML <img ... /> tag for the thumbnail, will include |
| 126 | 131 | * width and height attributes and a blank alt text (as required). |
| 127 | 132 | * |
| 128 | | - * @param array $options Associative array of options. Boolean options |
| | 133 | + * @param $options Associative array of options. Boolean options |
| 129 | 134 | * should be indicated with a value of true for true, and false or |
| 130 | 135 | * absent for false. |
| 131 | 136 | * |
| — | — | @@ -133,7 +138,7 @@ |
| 134 | 139 | * desc-link Boolean, show a description link |
| 135 | 140 | * file-link Boolean, show a file download link |
| 136 | 141 | * valign vertical-align property, if the output is an inline element |
| 137 | | - * img-class Class applied to the <img> tag, if there is such a tag |
| | 142 | + * img-class Class applied to the \<img\> tag, if there is such a tag |
| 138 | 143 | * desc-query String, description link query params |
| 139 | 144 | * custom-url-link Custom URL to link to |
| 140 | 145 | * custom-title-link Custom Title object to link to |
| — | — | @@ -142,7 +147,6 @@ |
| 143 | 148 | * sounds and videos, they may be displayed in other ways. |
| 144 | 149 | * |
| 145 | 150 | * @return string |
| 146 | | - * @public |
| 147 | 151 | */ |
| 148 | 152 | function toHtml( $options = array() ) { |
| 149 | 153 | if ( count( func_get_args() ) == 2 ) { |