From 3c13508b25da810f5ffabc3d2f34180d51f19ecc Mon Sep 17 00:00:00 2001 From: Araq Date: Wed, 13 May 2015 12:17:11 +0200 Subject: terminal: doc improvments --- lib/pure/terminal.nim | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/pure/terminal.nim b/lib/pure/terminal.nim index 29f700db5..7b4d548fe 100644 --- a/lib/pure/terminal.nim +++ b/lib/pure/terminal.nim @@ -364,7 +364,13 @@ macro styledEcho*(m: varargs[expr]): stmt = result.add(newCall(bindSym"write", bindSym"stdout", newStrLitNode("\n"))) result.add(newCall(bindSym"resetAttributes")) -when not defined(windows): +when defined(nimdoc): + proc getch*(): char = + ## Read a single character from the terminal, blocking until it is entered. + ## The character is not printed to the terminal. This is not available for + ## Windows. + discard +elif not defined(windows): proc getch*(): char = ## Read a single character from the terminal, blocking until it is entered. ## The character is not printed to the terminal. This is not available for -- cgit 1.4.1-2-gfad0