funktionskommentare hinzugefügt

This commit is contained in:
Manuel Friedli 2013-11-25 11:05:25 +01:00
parent 6c08386c82
commit d9801526a9

20
uhr.js
View file

@ -99,12 +99,32 @@ function Letter(value, style = '') {
Letter.prototype.toString = function letterToString() { Letter.prototype.toString = function letterToString() {
return "<span class=\"" + this.getStyle() + "\">" + this.getValue() + "</span>"; return "<span class=\"" + this.getStyle() + "\">" + this.getValue() + "</span>";
} }
/**
* Hilfsfunktion, um einen Buchstaben zu erzeugen.
*
* @param letter string: Der Buchstabe, der angezeigt werden soll
* @example l('I', 'is') erzeugt den Buchstaben 'I' mit der CSS-Styleklasse 'is'
*/
function l(letter, style) { function l(letter, style) {
return new Letter(letter, style); return new Letter(letter, style);
} }
/**
* Hilfsfunktion, um einen Buchstaben zu erzeugen, der zu einem Stunden-Wort gehört.
*
* @param letter string: Der Buchstabe, der angezeigt werden soll
* @param hour integer: Die Stunde, zu der der Buchstabe gehört (Ganzzahl zwischen 1 und 12)
* @example h('Z', 2) erzeugt den Buchstaben 'Z', der um 2:xx und 14:xx aktiv angezeigt wird
*/
function h(letter, hour) { function h(letter, hour) {
return l(letter, 'hour' + hour); return l(letter, 'hour' + hour);
} }
/**
* Hilfsfunktion, um einen Buchstaben zu erzeugen, der zu einem Minuten-Wort gehört.
*
* @param letter string: Der Buchstabe, der angezeigt werden soll
* @param minutes... integer: Eine AUfzählung von Minutenwerten, zu welchen der Buchstabe als aktiv angezeigt werden soll
* @example m('A', 5, 10, 15, 20, 35) erzeugt den Buchstaben 'A' der um :05, :10, :15, :20 und :35 aktiv angezeigt wird
*/
function m(letter) { function m(letter) {
var style = ''; var style = '';
for (var i = 1; i < arguments.length; i++) { for (var i = 1; i < arguments.length; i++) {