Skip to content

Commit cfb0a8d

Browse files
committed
- (Bug Fix) Updated code comments
1 parent 3df2ae3 commit cfb0a8d

File tree

2 files changed

+34
-23
lines changed

2 files changed

+34
-23
lines changed

src/flipclock/js/libs/factory.js

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@
2525

2626
FlipClock.Factory = FlipClock.Base.extend({
2727

28+
/**
29+
* The clock's animation rate.
30+
*
31+
* Note, currently this property doesn't do anything.
32+
* This property is here to be used in the future to
33+
* programmaticaly set the clock's animation speed
34+
*/
35+
36+
animationRate: 1000,
37+
2838
/**
2939
* Auto start the clock on page load (True|False)
3040
*/
@@ -86,29 +96,41 @@
8696
defaultLanguage: 'english',
8797

8898
/**
89-
* The language being used to display labels (string)
99+
* The jQuery object
100+
*/
101+
102+
$el: false,
103+
104+
/**
105+
* The FlipClock.Face object
90106
*/
91107

92-
language: 'english',
108+
face: true,
93109

94110
/**
95111
* The language object after it has been loaded
96112
*/
97113

98114
lang: false,
99115

116+
/**
117+
* The language being used to display labels (string)
118+
*/
119+
120+
language: 'english',
121+
122+
/**
123+
* The minimum digits the clock must have
124+
*/
125+
126+
minimumDigits: 0,
127+
100128
/**
101129
* The original starting value of the clock. Used for the reset method.
102130
*/
103131

104132
original: false,
105133

106-
/**
107-
* The FlipClock.Face object
108-
*/
109-
110-
face: true,
111-
112134
/**
113135
* Is the clock running? (True|False)
114136
*/
@@ -127,18 +149,6 @@
127149

128150
timer: false,
129151

130-
/**
131-
* An array of FlipClock.List objects
132-
*/
133-
134-
lists: [],
135-
136-
/**
137-
* The jQuery object
138-
*/
139-
140-
$el: false,
141-
142152
/**
143153
* The jQuery object (depcrecated)
144154
*/
@@ -171,8 +181,8 @@
171181
this.original = (digit instanceof Date) ? digit : (digit ? Math.round(digit) : 0);
172182

173183
this.time = new FlipClock.Time(this, this.original, {
174-
minimumDigits: options.minimumDigits ? options.minimumDigits : 0,
175-
animationRate: options.animationRate ? options.animationRate : 1000
184+
minimumDigits: this.minimumDigits,
185+
animationRate: this.animationRate
176186
});
177187

178188
this.timer = new FlipClock.Timer(this, options);
@@ -184,6 +194,7 @@
184194
if(this.autoStart) {
185195
this.start();
186196
}
197+
187198
},
188199

189200
/**

src/flipclock/js/libs/timer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
interval: 1000,
5555

5656
/**
57-
* The rate of the animation in milliseconds
57+
* The rate of the animation in milliseconds (not currently in use)
5858
*/
5959

6060
animationRate: 1000,

0 commit comments

Comments
 (0)