diff options
author | Vincent Sanders <vince@kyllikki.org> | 2014-10-19 19:12:55 +0100 |
---|---|---|
committer | Vincent Sanders <vince@kyllikki.org> | 2014-10-19 19:12:55 +0100 |
commit | 1180d1932480234619163d57a4dc2629c9309f38 (patch) | |
tree | d1857aabc48620223606b4e45dfecb1d6f586f20 /desktop/browser_private.h | |
parent | 686fd09ad805ab961cf8c24f7c172ba15a45a2d1 (diff) | |
download | netsurf-1180d1932480234619163d57a4dc2629c9309f38.tar.gz netsurf-1180d1932480234619163d57a4dc2629c9309f38.tar.bz2 |
improve documentation in headers
Diffstat (limited to 'desktop/browser_private.h')
-rw-r--r-- | desktop/browser_private.h | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/desktop/browser_private.h b/desktop/browser_private.h index d2c48d704..7ebdd6ebd 100644 --- a/desktop/browser_private.h +++ b/desktop/browser_private.h @@ -163,14 +163,32 @@ struct browser_window { +/** + * Initialise common parts of a browser window + * + * \param flags Flags to control operation + * \param bw The window to initialise + * \param existing The existing window if cloning, else NULL + */ nserror browser_window_initialise_common(enum browser_window_create_flags flags, struct browser_window *bw, struct browser_window *existing); /** + * Get the dimensions of the area a browser window occupies + * + * \param bw The browser window to get dimensions of + * \param width Updated to the browser window viewport width + * \param height Updated to the browser window viewport height + * \param scaled Whether we want the height with scale applied + */ +void browser_window_get_dimensions(struct browser_window *bw, + int *width, int *height, bool scaled); + +/** * Update the extent of the inside of a browser window to that of the current * content * - * \param bw browser_window to update the extent of + * \param bw browser_window to update the extent of */ void browser_window_update_extent(struct browser_window *bw); |