mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-07-20 07:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix doccomment of macros.get{Size,Align,Offset} [ci skip] (#11346)

Browse Source
This commit is contained in:
Arne Döring
2019-05-28 15:57:27 +02:00
committed by Andreas Rumpf
parent 9d8b4d6020
commit 35593700fa
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
lib/core/macros.nim
View File

@@ -1596,12 +1596,17 @@ proc getProjectPath*(): string = discard
when defined(nimMacrosSizealignof):
proc getSize*(arg: NimNode): int {.magic: "NSizeOf", noSideEffect.} =
## Returns the same result as ``system.sizeof``, but it works on
## ``NimNode`` for use in macro context.
## Returns the same result as ``system.sizeof`` if the size is
## known by the Nim compiler. Returns a negative value if the Nim
## compiler does not know the size.
proc getAlign*(arg: NimNode): int {.magic: "NSizeOf", noSideEffect.} =
## Returns the same result as ``system.alignof``, but it works on
## ``NimNode`` for use in macro context.
## Returns the same result as ``system.alignof`` if the alignment
## is known by the Nim compiler. It works on ``NimNode`` for use
## in macro context. Returns a negative value if the Nim compiler
## does not know the alignment.
proc getOffset*(arg: NimNode): int {.magic: "NSizeOf", noSideEffect.} =
## Returns the same result as ``system.offsetof``, but it expects
## a resolved symbol node from a field of a type. Therefore it
## only requires one argument instead of two.
## Returns the same result as ``system.offsetof`` if the offset is
## known by the Nim compiler. It expects a resolved symbol node
## from a field of a type. Therefore it only requires one argument
## instead of two. Returns a negative value if the Nim compiler
## does not know the offset.