Embedded/elua
1
0
Fork 0
mirror of https://github.com/elua/elua.git synced 2025-01-08 20:56:17 +08:00
Code Issues Projects Releases Wiki Activity

Fix typos in en_refman_gen_tmr doc

Browse Source
This commit is contained in:
Martin Guy 2011-04-23 18:56:41 +02:00
parent 593b4b9232
commit f49b44eae6
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/eluadoc/refman_gen_tmr.lua
View File

@ -17,7 +17,7 @@ data_en =
be available by using $tmr.VIRT0$ to $tmr.VIRT3$ as timer IDs.</p>
<p>All "time units" (delays, differences in time) in this module, as well as in other parts of eLua (timeouts) are expressed in microseconds. However,
please keep in mind that the actual timer resolution depends on many factors. For example, it's very likely that the @#tmr.delay@tmr.delay@ function won't
be able to delay for the exact amount you specify (in us), as the real delay depends ona number of variables, most notably the base clock of the timer
be able to delay for the exact amount you specify (in us), as the real delay depends on a number of variables, most notably the base clock of the timer
and the size of the timer counter register (32 bits on some platforms, 16 bits on most platforms, other values are less common). To ensure that the delay
you're requesting is achievable, use @#tmr.getmindelay@tmr.getmindelay@ and @#tmr.getmaxdelay@tmr.getmaxdelay@ to obtain the maximum and the minimum
achievable wait times on your timer, respectively. Even if your delay is within these limits, the $precision$ of this function still varies a lot,
@ -59,13 +59,13 @@ data_en =
},
{ sig = "mindelay = #tmr.getmindelay#( id )",
desc = "Get the minimum achieavable delay on the specified timer.",
desc = "Get the minimum achievable delay on the specified timer.",
args = "$id$ - the timer ID.",
ret = "The minimum achievable delay on the specified timer (in us)."
},
{ sig = "maxdelay = #tmr.getmaxdelay#( id )",
desc = "Get the maximum achieavable delay on the specified timer.",
desc = "Get the maximum achievable delay on the specified timer.",
args = "$id$ - the timer ID.",
ret = "The maximum achievable delay on the specified timer (in us)."
},