From 05a64bfde9fe91587a7f8bd3d32f8577b80c7328 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sat, 8 Nov 2014 16:49:32 +0000 Subject: fix up more doxygen errors --- content/content_protected.h | 47 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) (limited to 'content/content_protected.h') diff --git a/content/content_protected.h b/content/content_protected.h index 2647b2e0f..1ae899891 100644 --- a/content/content_protected.h +++ b/content/content_protected.h @@ -194,11 +194,58 @@ int content__get_width(struct content *c); int content__get_height(struct content *c); int content__get_available_width(struct content *c); const char *content__get_source_data(struct content *c, unsigned long *size); + +/** + * Invalidate content reuse data. + * + * causes subsequent requests for content URL to query server to + * determine if content can be reused. This is required behaviour for + * forced reloads etc. + * + * \param c Content to invalidate. + */ void content__invalidate_reuse_data(struct content *c); + +/** + * Retrieve the refresh URL for a content + * + * \param c Content to retrieve refresh URL from + * \return Pointer to URL or NULL if none + */ nsurl *content__get_refresh_url(struct content *c); + +/** + * Retrieve the bitmap contained in an image content + * + * \param c Content to retrieve opacity from + * \return Pointer to bitmap or NULL if none. + */ struct bitmap *content__get_bitmap(struct content *c); + +/** + * Determine if a content is opaque + * + * \param c Content to retrieve opacity from + * \return false if the content is not opaque or information is not + * known else true. + */ bool content__get_opaque(struct content *c); + +/** + * Retrieve the encoding of a content + * + * \param c the content to examine the encoding of. + * \param op encoding operation. + * \return Pointer to content info or NULL if none. + */ const char *content__get_encoding(struct content *c, enum content_encoding_type op); + +/** + * Return whether a content is currently locked + * + * \param c Content to test + * \return true iff locked, else false + */ bool content__is_locked(struct content *c); #endif -- cgit v1.2.3