Corewindow helper: Add documentation for cw_helper_scroll_visible()

This commit is contained in:
Michael Drake 2019-08-03 16:38:09 +01:00
parent 11ecf0b671
commit 342b65fd76
1 changed files with 8 additions and 1 deletions

View File

@ -29,7 +29,14 @@ struct rect;
struct core_window;
struct core_window_callback_table;
/* exported interface documented in cw_helper.h */
/**
* Scroll a core window to make the given rectangle visible.
*
* \param[in] cw_t The core window callback table to use.
* \param[in] cw_h The core window's handle.
* \param[in] r The rectangle to make visisble by scrolling.
* \return NSERROR_OK on success or appropriate error code
*/
nserror cw_helper_scroll_visible(
const struct core_window_callback_table *cw_t,
struct core_window *cw_h,