From b59b93d3943262cb66e3355e0c9ce0ea672ff196 Mon Sep 17 00:00:00 2001 From: jonas Date: Fri, 1 Feb 2019 13:38:52 +0100 Subject: Documentation --- cInput.h | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'cInput.h') diff --git a/cInput.h b/cInput.h index 49d13b7..529aa81 100644 --- a/cInput.h +++ b/cInput.h @@ -32,7 +32,12 @@ struct sInputEvent unsigned int b; int x, y; }; - +/** +* ##cInput +* * puts STDIN in raw mode +* * activates mouse tracking +* * reverts console back to normal operation on destruction. +*/ class cInput { public: @@ -42,7 +47,12 @@ public: /** Reads inputevents * returns event struct - * event queu is empty, when sInputEvent.type == _EVENT_NULL + * ### sInputEvent.type + * * _EVENT_NULL: No input recorded + * * _EVENT_CHAR: A Key was pressed, stored in .c + * * _EVENT_KEY: Escape sequence recorded, stored in .c without escape char + * * _EVENT_MOUSE: Console registered click at (.x, .y) with origin at (0,0) (top left). Mouse button stored in b. + * * _EVENT_TERM: Console registered Ctrl+C */ sInputEvent poll(); -- cgit v1.2.3 From c459b4901f3f453f83a93a38228e3241dd8190c2 Mon Sep 17 00:00:00 2001 From: Jonas Gunz Date: Fri, 1 Feb 2019 19:51:37 +0100 Subject: Documentation update --- cInput.h | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) (limited to 'cInput.h') diff --git a/cInput.h b/cInput.h index 529aa81..00ddb7d 100644 --- a/cInput.h +++ b/cInput.h @@ -1,9 +1,3 @@ -/* -* cInput is responsible for Handling everything related to setting up and managing the console window -* as well as decoding keyboard and mouse events. -* Compatible with xterm compatible terminal emulators -*/ - #ifndef CINPUT_H_ #define CINPUT_H_ @@ -37,6 +31,7 @@ struct sInputEvent * * puts STDIN in raw mode * * activates mouse tracking * * reverts console back to normal operation on destruction. +* Compatible with xterm compatible terminal emulators */ class cInput { -- cgit v1.2.3