Добавлена документация по доступному функционалу.
This commit is contained in:
parent
5bd192a788
commit
80518ee8ed
3 changed files with 142 additions and 0 deletions
43
doc/pages/checks.md
Normal file
43
doc/pages/checks.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# Проверки ncurses-вызовов
|
||||
|
||||
Функции для проверяемых ncurses-вызовов и единых сообщений об ошибках.
|
||||
|
||||
---
|
||||
|
||||
## ncuiExpect
|
||||
|
||||
Вызывает `fn(args)` и проверяет `result == expected`.
|
||||
|
||||
- Тип `expected` должен совпадать с типом результата `fn(args)`.
|
||||
- При ошибке выбрасывается исключение с местом вызова.
|
||||
- Возвращается `result`.
|
||||
|
||||
---
|
||||
|
||||
## ncuiExpectMsg
|
||||
|
||||
Вызывает `fn(args)` и проверяет `result == expected`, добавляя `message`.
|
||||
|
||||
- Тип `expected` должен совпадать с типом результата `fn(args)`.
|
||||
- При ошибке выбрасывается исключение с местом вызова.
|
||||
- Возвращается `result`.
|
||||
|
||||
---
|
||||
|
||||
## ncuiNotErr
|
||||
|
||||
Вызывает `fn(args)` и проверяет `result != ERR`.
|
||||
|
||||
- `fn(args)` должна возвращать тип `ERR`.
|
||||
- При ошибке выбрасывается исключение с местом вызова.
|
||||
- Возвращается `result`.
|
||||
|
||||
---
|
||||
|
||||
## ncuiNotNull
|
||||
|
||||
Вызывает `fn(args)` и проверяет `result !is null`.
|
||||
|
||||
- `fn(args)` должна возвращать указатель.
|
||||
- При ошибке выбрасывается исключение с местом вызова.
|
||||
- Возвращается `result`.
|
||||
Loading…
Add table
Add a link
Reference in a new issue