Improve documentation

This commit is contained in:
Georgii Surkov
2024-03-12 19:54:45 +03:00
parent 98c328f93f
commit 75432346de
3 changed files with 12 additions and 2 deletions

View File

@@ -1,6 +1,8 @@
/**
* @file view_dispatcher.h
* GUI: ViewDispatcher API
* @brief GUI: ViewDispatcher API
*
* @warning Views added to a ViewDispatcher MUST NOT be in a ViewStack at the same time.
*/
#pragma once

View File

@@ -1,3 +1,9 @@
/**
* @file view_holder.h
* @brief GUI: ViewHolder API
*
* @warning View added to a ViewHolder MUST NOT be in a ViewStack at the same time.
*/
#pragma once
#include <gui/view.h>

View File

@@ -1,11 +1,13 @@
/**
* @file view_stack.h
* GUI: ViewStack API
* @brief GUI: ViewStack API
*
* ViewStack accumulates several Views in one stack.
* Draw callbacks are called sequenctially starting from
* first added. Input callbacks are called in reverse order.
* Consumed input is not passed on underlying layers.
*
* @warning Views added to a ViewStack MUST NOT be in a ViewDispatcher or a ViewHolder at the same time.
*/
#pragma once