minor documentation improvements

This commit is contained in:
Araq 2014-12-08 08:42:59 +01:00
commit 02f085b479

View file

@ -7,9 +7,12 @@
# distribution, for details about the copyright. # distribution, for details about the copyright.
# #
## This module implements an interface to Nimrod's runtime type information. ## This module implements an interface to Nim's runtime type information.
## Note that even though ``TAny`` and its operations hide the nasty low level ## Note that even though ``TAny`` and its operations hide the nasty low level
## details from its clients, it remains inherently unsafe! ## details from its clients, it remains inherently unsafe!
##
## See the `marshal <marshal.html>`_ module for what this module allows you
## to do.
{.push hints: off.} {.push hints: off.}
@ -51,7 +54,7 @@ type
akUInt32 = 43, ## any represents an unsigned int32 akUInt32 = 43, ## any represents an unsigned int32
akUInt64 = 44, ## any represents an unsigned int64 akUInt64 = 44, ## any represents an unsigned int64
TAny* = object {.pure.} ## can represent any nim value; NOTE: the wrapped TAny* = object ## can represent any nim value; NOTE: the wrapped
## value can be modified with its wrapper! This means ## value can be modified with its wrapper! This means
## that ``TAny`` keeps a non-traced pointer to its ## that ``TAny`` keeps a non-traced pointer to its
## wrapped value and **must not** live longer than ## wrapped value and **must not** live longer than
@ -62,7 +65,7 @@ type
ppointer = ptr pointer ppointer = ptr pointer
pbyteArray = ptr array[0.. 0xffff, int8] pbyteArray = ptr array[0.. 0xffff, int8]
TGenSeq {.pure.} = object TGenSeq = object
len, space: int len, space: int
PGenSeq = ptr TGenSeq PGenSeq = ptr TGenSeq