| Index: trunk/extensions/Score/Score.body.php |
| — | — | @@ -67,7 +67,7 @@ |
| 68 | 68 | const LILYPOND_DIR_NAME = 'lilypond'; |
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | | - * Supported score languages |
| | 71 | + * Supported score languages. |
| 72 | 72 | */ |
| 73 | 73 | private static $supportedLangs = array( 'lilypond', 'ABC' ); |
| 74 | 74 | |
| — | — | @@ -142,10 +142,10 @@ |
| 143 | 143 | /** |
| 144 | 144 | * Renders the score code (LilyPond, ABC, etc.) in a <score>…</score> tag. |
| 145 | 145 | * |
| 146 | | - * @param $code |
| 147 | | - * @param $args |
| 148 | | - * @param $parser |
| 149 | | - * @param $frame |
| | 146 | + * @param $code score code. |
| | 147 | + * @param $args array of score tag attributes. |
| | 148 | + * @param $parser Parser of Mediawiki. |
| | 149 | + * @param $frame PPFrame expansion frame, not used by this extension. |
| 150 | 150 | * |
| 151 | 151 | * @return Image link HTML, and possibly anchor to MIDI file. |
| 152 | 152 | */ |
| — | — | @@ -392,8 +392,8 @@ |
| 393 | 393 | /** |
| 394 | 394 | * Embeds simple LilyPond code in a score block. |
| 395 | 395 | * |
| 396 | | - * @param $lilypondCode |
| 397 | | - * @param $options |
| | 396 | + * @param $lilypondCode simple LilyPond code. |
| | 397 | + * @param $options rendering options, see Score::generateHTML() for explanation. |
| 398 | 398 | * |
| 399 | 399 | * @return Raw lilypond code. |
| 400 | 400 | * |
| — | — | @@ -519,8 +519,8 @@ |
| 520 | 520 | /** |
| 521 | 521 | * Trims an image with ImageMagick. |
| 522 | 522 | * |
| 523 | | - * @param $source |
| 524 | | - * @param $dest |
| | 523 | + * @param $source path to the source image. |
| | 524 | + * @param $dest path to the target (trimmed) image. |
| 525 | 525 | * |
| 526 | 526 | * @throws ScoreException on error. |
| 527 | 527 | */ |
| — | — | @@ -541,7 +541,7 @@ |
| 542 | 542 | /** |
| 543 | 543 | * Deletes a directory with no subdirectories with all files in it. |
| 544 | 544 | * |
| 545 | | - * @param $dir |
| | 545 | + * @param $dir path to the directory that is to be deleted. |
| 546 | 546 | * |
| 547 | 547 | * @return true on success, false on error |
| 548 | 548 | */ |
| — | — | @@ -563,7 +563,7 @@ |
| 564 | 564 | /** |
| 565 | 565 | * Writes the specified message to the Score debug log. |
| 566 | 566 | * |
| 567 | | - * @param $msg |
| | 567 | + * @param $msg message to log. |
| 568 | 568 | */ |
| 569 | 569 | private static function debug( $msg ) { |
| 570 | 570 | wfDebugLog( 'Score', $msg ); |