Minor doc comment fixes

Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
This commit is contained in:
Christopher Arndt 2024-05-23 18:15:52 +02:00
parent 11c9fc653d
commit 1dcf5ac82f
1 changed files with 6 additions and 5 deletions

View File

@ -163,18 +163,19 @@ type
## ##
## The body of an AtomSequence (a sequence of events). ## The body of an AtomSequence (a sequence of events).
## ##
## The unit field is either a Urid that described an appropriate time stamp ## The unit field is either a Urid that describes an appropriate time stamp
## type, or may be 0 where a default stamp is known. For ## type, or may be 0 where a default stamp type is known. For
## lv2Descriptor.run(), the default stamp is audio frames. ## lv2Descriptor.run(), the default stamp type is audio frames.
## ##
## The contents of a sequence is a series of AtomEvent, each aligned ## The contents of a sequence is a series of AtomEvent, each aligned
## to 64-bits, for example: ## to 64-bits, for example:
## <pre> ##
## ```
## | Event 1 (size 6) | Event 2 ## | Event 1 (size 6) | Event 2
## | | | | | | | | | ## | | | | | | | | |
## | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ## | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
## |FRAMES |SIZE |TYPE |DATADATADATAPAD|FRAMES |... ## |FRAMES |SIZE |TYPE |DATADATADATAPAD|FRAMES |...
## </pre> ## ```
## ##
AtomSequenceBody* {.bycopy.} = object AtomSequenceBody* {.bycopy.} = object
unit*: Urid ## Urid of unit of event time stamps. unit*: Urid ## Urid of unit of event time stamps.