diff options
| author | Michael Drake <michael.drake@codethink.co.uk> | 2019-08-03 16:38:09 +0100 |
|---|---|---|
| committer | Michael Drake <michael.drake@codethink.co.uk> | 2019-08-03 16:38:09 +0100 |
| commit | 342b65fd76de0b26cda3fecf2140b547b5e11b2e (patch) | |
| tree | 03a465501c355c5b640ee5d0fd94024d66ad3551 | |
| parent | 11ecf0b6712d1817beef9a5907f462adf89c3d33 (diff) | |
| download | netsurf-342b65fd76de0b26cda3fecf2140b547b5e11b2e.tar.gz netsurf-342b65fd76de0b26cda3fecf2140b547b5e11b2e.tar.bz2 | |
Corewindow helper: Add documentation for cw_helper_scroll_visible()
| -rw-r--r-- | desktop/cw_helper.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/desktop/cw_helper.h b/desktop/cw_helper.h index 83a85c1b5..14e699342 100644 --- a/desktop/cw_helper.h +++ b/desktop/cw_helper.h @@ -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, |