diff options
| author | Yohann Ferreira <yohann_dot_ferreira_at_orange_dot_efer> | 2011-04-30 23:35:06 +0200 |
|---|---|---|
| committer | Yohann Ferreira <yohann_dot_ferreira_at_orange_dot_efer> | 2011-04-30 23:35:06 +0200 |
| commit | a01ad865cd431f919b2d177ccfb035ee6c7c1609 (patch) | |
| tree | 73b7536252c67ad2053253d4c8369ef6402d8fdf /src/client.h | |
| parent | f84906fd493fe77a0f6591afb167ee62c9315506 (diff) | |
| download | mana-a01ad865cd431f919b2d177ccfb035ee6c7c1609.tar.gz mana-a01ad865cd431f919b2d177ccfb035ee6c7c1609.tar.bz2 mana-a01ad865cd431f919b2d177ccfb035ee6c7c1609.tar.xz mana-a01ad865cd431f919b2d177ccfb035ee6c7c1609.zip | |
De-dustify the get_elapsed-time function documentation a bit.
Trivial.
Diffstat (limited to 'src/client.h')
| -rw-r--r-- | src/client.h | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/src/client.h b/src/client.h index 4a0bc750..ba8d6906 100644 --- a/src/client.h +++ b/src/client.h @@ -56,12 +56,21 @@ extern std::string errorMessage; extern LoginData loginData; /** - * Returns elapsed time. (Warning: supposes the delay is always < 100 seconds) + * get_elapsed_time + * + * @param startTime The value to check in client ticks. + * + * @return the elapsed time in milliseconds. + * between startTime and the current client tick value. + * + * @warning This function can't handle delays > 10 seconds. + * @see MILLISECONDS_IN_A_TICK + * @see tick_time */ -int get_elapsed_time(int start_time); +int get_elapsed_time(int startTime); /** - * Returns if this call and the last call were done for the same + * Returns whether this call and the last call were done for the same * selected index and within a short time. */ bool isDoubleClick(int selected); |