summaryrefslogtreecommitdiffstats
path: root/spec/rtems/timer/if/get-information.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-10 16:04:24 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-17 18:30:13 +0100
commit0da6598dd0defdccd9944a8571f2253a2ac1f55c (patch)
treea276db5c85eccca583af6ac3a52eba937e59a5f0 /spec/rtems/timer/if/get-information.yml
parentspec: Document clock manager (diff)
downloadrtems-central-0da6598dd0defdccd9944a8571f2253a2ac1f55c.tar.bz2
spec: Use EARS syntax
Diffstat (limited to 'spec/rtems/timer/if/get-information.yml')
-rw-r--r--spec/rtems/timer/if/get-information.yml5
1 files changed, 3 insertions, 2 deletions
diff --git a/spec/rtems/timer/if/get-information.yml b/spec/rtems/timer/if/get-information.yml
index a69032eb..5c1c3597 100644
--- a/spec/rtems/timer/if/get-information.yml
+++ b/spec/rtems/timer/if/get-information.yml
@@ -38,8 +38,9 @@ params:
dir: null
name: id
- description: |
- is the pointer to a timer information variable. The information about the
- timer will be stored in this variable, in case of a successful operation.
+ is the pointer to a timer information variable. When the directive call is
+ successful, the information about the timer will be stored in this
+ variable.
dir: out
name: the_info
return: