fixes pre-existing quit documentation regression [backport] (#20763)

fixes pre-existing `quit` documentation regression
This commit is contained in:
ringabout 2022-11-06 18:50:10 +08:00 • committed by GitHub
commit fc8bfd781a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2258,6 +2258,9 @@ when defined(js):
when defined(nimNoQuit): when defined(nimNoQuit):
proc quit*(errorcode: int = QuitSuccess) = discard "ignoring quit" proc quit*(errorcode: int = QuitSuccess) = discard "ignoring quit"
elif defined(nimdoc):
proc quit*(errorcode: int = QuitSuccess) {.magic: "Exit", noreturn.}
## Stops the program immediately with an exit code. ## Stops the program immediately with an exit code.
## ##
## Before stopping the program the "exit procedures" are called in the ## Before stopping the program the "exit procedures" are called in the
@ -2286,9 +2289,6 @@ when defined(nimNoQuit):
## It does *not* call the garbage collector to free all the memory, ## It does *not* call the garbage collector to free all the memory,
## unless an `addExitProc` proc calls `GC_fullCollect <#GC_fullCollect>`_. ## unless an `addExitProc` proc calls `GC_fullCollect <#GC_fullCollect>`_.
elif defined(nimdoc):
proc quit*(errorcode: int = QuitSuccess) {.magic: "Exit", noreturn.}
elif defined(genode): elif defined(genode):
proc quit*(errorcode: int = QuitSuccess) {.inline, noreturn.} = proc quit*(errorcode: int = QuitSuccess) {.inline, noreturn.} =
rawQuit(errorcode) rawQuit(errorcode)