diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-02-10 16:04:24 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-02-17 18:30:13 +0100 |
| commit | 0da6598dd0defdccd9944a8571f2253a2ac1f55c (patch) | |
| tree | a276db5c85eccca583af6ac3a52eba937e59a5f0 /spec/rtems/timer/if | |
| parent | spec: Document clock manager (diff) | |
| download | rtems-central-0da6598dd0defdccd9944a8571f2253a2ac1f55c.tar.bz2 | |
spec: Use EARS syntax
Diffstat (limited to 'spec/rtems/timer/if')
| -rw-r--r-- | spec/rtems/timer/if/create.yml | 6 | ||||
| -rw-r--r-- | spec/rtems/timer/if/get-information.yml | 5 | ||||
| -rw-r--r-- | spec/rtems/timer/if/ident.yml | 6 |
3 files changed, 9 insertions, 8 deletions
diff --git a/spec/rtems/timer/if/create.yml b/spec/rtems/timer/if/create.yml index ba8be42a..e7aab890 100644 --- a/spec/rtems/timer/if/create.yml +++ b/spec/rtems/timer/if/create.yml @@ -50,9 +50,9 @@ params: dir: null name: name - description: | - is the pointer to an object identifier variable. The identifier of the - created timer will be stored in this variable, in case of a successful - operation. + is the pointer to an object identifier variable. When the directive call + is successful, the identifier of the created timer will be stored in this + variable. dir: out name: id return: 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: diff --git a/spec/rtems/timer/if/ident.yml b/spec/rtems/timer/if/ident.yml index c99b4981..3c351e2d 100644 --- a/spec/rtems/timer/if/ident.yml +++ b/spec/rtems/timer/if/ident.yml @@ -46,9 +46,9 @@ params: dir: null name: name - description: | - is the pointer to an object identifier variable. The object identifier of - an object with the specified name will be stored in this variable, in case - of a successful operation. + is the pointer to an object identifier variable. When the directive call + is successful, the object identifier of an object with the specified name + will be stored in this variable. dir: out name: id return: |