diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-21 19:32:58 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-21 19:45:38 +0200 |
| commit | 929a974cdd0f1971266fd20f53b688feb18f5624 (patch) | |
| tree | 13bd6bb5195f7acc8fa8683d7d24669d35c94445 /spec/rtems/support/if/microseconds-to-ticks.yml | |
| parent | spec: Update /rtems/dpmen/* documentatation (diff) | |
| download | rtems-central-929a974cdd0f1971266fd20f53b688feb18f5624.tar.bz2 | |
spec: Update /rtems/support/* documentation
Diffstat (limited to 'spec/rtems/support/if/microseconds-to-ticks.yml')
| -rw-r--r-- | spec/rtems/support/if/microseconds-to-ticks.yml | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/spec/rtems/support/if/microseconds-to-ticks.yml b/spec/rtems/support/if/microseconds-to-ticks.yml index 6aa65914..57d7591f 100644 --- a/spec/rtems/support/if/microseconds-to-ticks.yml +++ b/spec/rtems/support/if/microseconds-to-ticks.yml @@ -1,8 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Returns the number of clock ticks for the specified microseconds value. + Gets the number of clock ticks for the microseconds value. copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2008 On-Line Applications Research Corporation (OAR) definition: default: | @@ -17,16 +17,21 @@ links: uid: header - role: interface-ingroup uid: group +- role: constraint + uid: /constraint/directive-ctx-any +- role: constraint + uid: /constraint/directive-no-preempt name: RTEMS_MICROSECONDS_TO_TICKS notes: | The number of clock ticks per second is defined by the ${/acfg/if/microseconds-per-tick:/name} application configuration option. params: -- description: is the microseconds value to convert to clock ticks. +- description: | + is the microseconds value to convert to clock ticks. dir: null name: _us return: return: | - The number of clock ticks for the specified microseconds value is returned. + Returns the number of clock ticks for the specified microseconds value. return-values: [] type: interface |