| Index: trunk/extensions/Score/Score.body.php |
| — | — | @@ -131,7 +131,7 @@ |
| 132 | 132 | * Creates the specified directory if it does not exist yet. |
| 133 | 133 | * Otherwise does nothing. |
| 134 | 134 | * |
| 135 | | - * @param $path path to directory to be created. |
| | 135 | + * @param $path string path to directory to be created. |
| 136 | 136 | * |
| 137 | 137 | * @throws ScoreException if the directory does not exist and could not be created. |
| 138 | 138 | */ |
| — | — | @@ -212,7 +212,7 @@ |
| 213 | 213 | * * midi: whether to link to a MIDI file, |
| 214 | 214 | * * raw: whether to assume raw LilyPond code. |
| 215 | 215 | * |
| 216 | | - * @return HTML. |
| | 216 | + * @return string HTML. |
| 217 | 217 | * |
| 218 | 218 | * @throws ScoreException if an error occurs. |
| 219 | 219 | */ |
| — | — | @@ -302,10 +302,10 @@ |
| 303 | 303 | /** |
| 304 | 304 | * Generates score PNG file(s) and possibly a MIDI file. |
| 305 | 305 | * |
| 306 | | - * @param $code score code. |
| 307 | | - * @param $options rendering options, see Score::generateHTML() for explanation. |
| 308 | | - * @param $filePrefix prefix for the generated files. |
| 309 | | - * @param $factoryDirectory directory of the working environment. |
| | 306 | + * @param $code string score code. |
| | 307 | + * @param $options array rendering options, see Score::generateHTML() for explanation. |
| | 308 | + * @param $filePrefix string prefix for the generated files. |
| | 309 | + * @param $factoryDirectory string directory of the working environment. |
| 310 | 310 | * |
| 311 | 311 | * @throws ScoreException on error. |
| 312 | 312 | */ |
| — | — | @@ -401,10 +401,10 @@ |
| 402 | 402 | /* trim output images if wanted */ |
| 403 | 403 | if ( $wgScoreTrim ) { |
| 404 | 404 | if ( file_exists( $factoryImage ) ) { |
| 405 | | - $rc = self::trimImage( $factoryImage, $factoryImageTrimmed ); |
| | 405 | + self::trimImage( $factoryImage, $factoryImageTrimmed ); |
| 406 | 406 | } |
| 407 | 407 | for ( $i = 1; file_exists( $f = sprintf( $factoryMultiFormat, $i ) ); ++$i ) { |
| 408 | | - $rc = self::trimImage( $f, sprintf( $factoryMultiTrimmedFormat, $i ) ); |
| | 408 | + self::trimImage( $f, sprintf( $factoryMultiTrimmedFormat, $i ) ); |
| 409 | 409 | } |
| 410 | 410 | } else { |
| 411 | 411 | $factoryImageTrimmed = $factoryImage; |
| — | — | @@ -436,10 +436,10 @@ |
| 437 | 437 | /** |
| 438 | 438 | * Embeds simple LilyPond code in a score block. |
| 439 | 439 | * |
| 440 | | - * @param $lilypondCode simple LilyPond code. |
| 441 | | - * @param $options rendering options, see Score::generateHTML() for explanation. |
| | 440 | + * @param $lilypondCode string simple LilyPond code. |
| | 441 | + * @param $options array rendering options, see Score::generateHTML() for explanation. |
| 442 | 442 | * |
| 443 | | - * @return Raw lilypond code. |
| | 443 | + * @return string Raw lilypond code. |
| 444 | 444 | * |
| 445 | 445 | * @throws ScoreException if determining the LilyPond version fails. |
| 446 | 446 | */ |
| — | — | @@ -471,9 +471,9 @@ |
| 472 | 472 | /** |
| 473 | 473 | * Generates an Ogg/Vorbis file from a MIDI file using timidity. |
| 474 | 474 | * |
| 475 | | - * @param $options rendering options, see Score::generateHTML() for explanation. |
| 476 | | - * @param $filePrefix prefix for the generated Ogg file. |
| 477 | | - * @param $factoryDirectory directory of the working environment. |
| | 475 | + * @param $options array rendering options, see Score::generateHTML() for explanation. |
| | 476 | + * @param $filePrefix string prefix for the generated Ogg file. |
| | 477 | + * @param $factoryDirectory string directory of the working environment. |
| 478 | 478 | * |
| 479 | 479 | * @throws ScoreException if an error occurs. |
| 480 | 480 | */ |
| — | — | @@ -519,10 +519,10 @@ |
| 520 | 520 | /** |
| 521 | 521 | * Generates LilyPond code. |
| 522 | 522 | * |
| 523 | | - * @param $code score code. |
| 524 | | - * @param $options rendering options, see Score::generateHTML() for explanation. |
| 525 | | - * @param $filePrefix prefix for the generated file. |
| 526 | | - * @param $factoryDirectory directory of the working environment. |
| | 523 | + * @param $code string score code. |
| | 524 | + * @param $options array rendering options, see Score::generateHTML() for explanation. |
| | 525 | + * @param $filePrefix string prefix for the generated file. |
| | 526 | + * @param $factoryDirectory string directory of the working environment. |
| 527 | 527 | * |
| 528 | 528 | * @return the generated LilyPond code. |
| 529 | 529 | * |
| — | — | @@ -554,9 +554,11 @@ |
| 555 | 555 | * |
| 556 | 556 | * $code ABC code. |
| 557 | 557 | * $factoryDirectory Working environment. As a side-effect, the |
| 558 | | - * LilyPond input file is created as "file.ly" in this directory. |
| | 558 | + * LilyPond input file is created as "file.ly" in this directory. |
| 559 | 559 | * |
| 560 | | - * @return the generated LilyPond code. |
| | 560 | + * @param $code string |
| | 561 | + * @param $factoryDirectory string |
| | 562 | + * @return string the generated LilyPond code. |
| 561 | 563 | * |
| 562 | 564 | * @throws ScoreException if the conversion fails. |
| 563 | 565 | */ |
| — | — | @@ -611,8 +613,8 @@ |
| 612 | 614 | /** |
| 613 | 615 | * Trims an image with ImageMagick. |
| 614 | 616 | * |
| 615 | | - * @param $source path to the source image. |
| 616 | | - * @param $dest path to the target (trimmed) image. |
| | 617 | + * @param $source string path to the source image. |
| | 618 | + * @param $dest string path to the target (trimmed) image. |
| 617 | 619 | * |
| 618 | 620 | * @throws ScoreException on error. |
| 619 | 621 | */ |
| — | — | @@ -633,7 +635,7 @@ |
| 634 | 636 | /** |
| 635 | 637 | * Deletes a directory with no subdirectories with all files in it. |
| 636 | 638 | * |
| 637 | | - * @param $dir path to the directory that is to be deleted. |
| | 639 | + * @param $dir string path to the directory that is to be deleted. |
| 638 | 640 | * |
| 639 | 641 | * @return true on success, false on error |
| 640 | 642 | */ |
| — | — | @@ -655,7 +657,7 @@ |
| 656 | 658 | /** |
| 657 | 659 | * Writes the specified message to the Score debug log. |
| 658 | 660 | * |
| 659 | | - * @param $msg message to log. |
| | 661 | + * @param $msg string message to log. |
| 660 | 662 | */ |
| 661 | 663 | private static function debug( $msg ) { |
| 662 | 664 | wfDebugLog( 'Score', $msg ); |