Skip to content

Commit a59099b

Browse files
authored
Fix 2 incorrect link names & add notes about min Solar2D version (coronalabs#50)
There were two incorrect link names in timer library's index page. Also, as per suggestion, this PR also adds notes on minimum version required to use the new API calls and tags in timer calls.
1 parent 1720f12 commit a59099b

File tree

11 files changed

+17
-6
lines changed

11 files changed

+17
-6
lines changed

markdown/api/library/timer/cancel.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This function returns two numbers: time remaining ( and number of iterations tha
2525
timer.cancel( whatToCancel )
2626

2727
##### whatToCancel ~^(required)^~
28-
_[Object][api.type.Object] or [String][api.type.String]._ The timer ID from, or `tag` passed to, [timer.performWithDelay()][api.library.timer.performWithDelay].
28+
_[Object][api.type.Object] or [String][api.type.String]._ The timer ID from, or `tag` passed to, [timer.performWithDelay()][api.library.timer.performWithDelay]. Note: Using `tag` requires `Solar2D 2020.3611` or a newer build.
2929

3030
## Example
3131

markdown/api/library/timer/cancelAll.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
Cancels all timer operations initiated with [timer.performWithDelay()][api.library.timer.performWithDelay].
1616

17+
Note: Using [timer.cancelAll()][api.library.timer.cancelAll] requires `Solar2D 2020.3611` or a newer build.
18+
1719
<!---
1820
1921
This function doesn't return any values.

markdown/api/library/timer/index.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ Timer functions allow calling a function some time in the future rather than imm
2121

2222
#### [timer.pause()][api.library.timer.pause]
2323

24-
#### [timer.pause()][api.library.timer.pauseAll]
24+
#### [timer.pauseAll()][api.library.timer.pauseAll]
2525

2626
#### [timer.performWithDelay()][api.library.timer.performWithDelay]
2727

2828
#### [timer.resume()][api.library.timer.resume]
2929

30-
#### [timer.resume()][api.library.timer.resumeAll]
30+
#### [timer.resumeAll()][api.library.timer.resumeAll]
3131

3232
## Properties
3333

markdown/api/library/timer/pause.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If a specific timer is paused, then the function returns a [number][api.type.Num
2222
timer.pause( whatToPause )
2323

2424
##### whatToPause ~^(required)^~
25-
_[Object][api.type.Object] or [String][api.type.String]._ The timer ID from, or `tag` passed to, [timer.performWithDelay()][api.library.timer.performWithDelay].
25+
_[Object][api.type.Object] or [String][api.type.String]._ The timer ID from, or `tag` passed to, [timer.performWithDelay()][api.library.timer.performWithDelay]. Note: Using `tag` requires `Solar2D 2020.3611` or a newer build.
2626

2727
## Example
2828

markdown/api/library/timer/pauseAll.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
Pauses all timers started with [timer.performWithDelay()][api.library.timer.performWithDelay].
1616

17+
Note: Using [timer.pauseAll()][api.library.timer.pauseAll] requires `Solar2D 2020.3611` or a newer build.
18+
1719
## Syntax
1820

1921
timer.pauseAll( timerId )

markdown/api/library/timer/performWithDelay.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ _[Listener][api.type.Listener]._ The listener to invoke after the delay. This ma
3939
_[Number][api.type.Number]._ Optionally specify the number of times `listener` is to be invoked. By default, it is `1`; pass `0` or `-1` if you want the timer to loop forever.
4040

4141
##### tag ~^(optional)^~
42-
_[String][api.type.String]._ Optionally assign a `tag` to the timer. You can pause, resume or cancel all timers that share the same `tag` with a single function call.
42+
_[String][api.type.String]._ Optionally assign a `tag` to the timer. You can pause, resume or cancel all timers that share the same `tag` with a single function call. Note: Using `tag` requires `Solar2D 2020.3611` or a newer build.
4343

4444

4545
## Examples

markdown/api/library/timer/resume.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If a specific timer is resumed, then the function returns a [number][api.type.Nu
2222
timer.resume( whatToResume )
2323

2424
##### whatToResume ~^(required)^~
25-
_[Object][api.type.Object] or [String][api.type.String]._ The timer ID from, or `tag` passed to, [timer.performWithDelay()][api.library.timer.performWithDelay].
25+
_[Object][api.type.Object] or [String][api.type.String]._ The timer ID from, or `tag` passed to, [timer.performWithDelay()][api.library.timer.performWithDelay]. Note: Using `tag` requires `Solar2D 2020.3611` or a newer build.
2626

2727

2828
## Example

markdown/api/library/timer/resumeAll.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
Resumes all timers that were paused with [timer.pause()][api.library.timer.pause].
1616

17+
Note: Using [timer.resumeAll()][api.library.timer.resumeAll] requires `Solar2D 2020.3611` or a newer build.
18+
1719
## Syntax
1820

1921
timer.resumeAll()

markdown/api/library/transition/cancelAll.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
The `transition.cancelAll()` function cancels all running and paused transitions.
1616

17+
Note: Using [transition.cancelAll()][api.library.transition.cancelAll] requires `Solar2D 2020.3611` or a newer build.
18+
1719

1820
## Syntax
1921

markdown/api/library/transition/pauseAll.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
The `transition.pauseAll()` function pauses all running transitions.
1616

17+
Note: Using [transition.pauseAll()][api.library.transition.pauseAll] requires `Solar2D 2020.3611` or a newer build.
18+
1719

1820
## Syntax
1921

0 commit comments

Comments
 (0)