| 281 | | }}} |
| | 281 | }}} |
| | 282 | * About the javadoc: |
| | 283 | * Write good javadoc that describes classes, methods and variables |
| | 284 | * Add yourself to the author list when you modify the logic, if your changes do not alter the logic don't do it. |
| | 285 | * Write parameter descriptions on the next row. |
| | 286 | * Write all the @parameter, @return, descriptions as a sentences which begin with upper case letter and end with a punctuation mark. Write the description itself of the javadoc even for getters and setters, write it as sentences! |
| | 287 | * Examples: |
| | 288 | {{{ |
| | 289 | /* |
| | 290 | * Moves the head position to a specified time in the timeline. If it |
| | 291 | * exceeds the length of the timeline, the position is not changed. |
| | 292 | * |
| | 293 | * @param time |
| | 294 | * The time to jump to (in seconds). |
| | 295 | * @return |
| | 296 | * The new head position. |
| | 297 | */ |
| | 298 | }}} |
