From 5562c9a553fe539d0d1fbf05dba89b1b1f577fae Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Sat, 8 Nov 2014 22:08:29 +0000
Subject: Continue doxygen error cleanup.

---
 content/content_protected.h | 59 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

(limited to 'content/content_protected.h')

diff --git a/content/content_protected.h b/content/content_protected.h
index 1ae899891..d22ff4b22 100644
--- a/content/content_protected.h
+++ b/content/content_protected.h
@@ -185,14 +185,71 @@ void content__reformat(struct content *c, bool background,
 void content__request_redraw(struct content *c,
 		int x, int y, int width, int height);
 
-bool content__set_title(struct content *c, const char *title);
 
+/**
+ * Retrieve mime-type of content
+ *
+ * \param c Content to retrieve mime-type of
+ * \return Pointer to referenced mime-type, or NULL if not found.
+ */
 lwc_string *content__get_mime_type(struct content *c);
+
+/**
+ * Set title associated with content
+ *
+ * \param c Content to set title on.
+ * \parm title The new title to set.
+ * \return true on sucess else false.
+ */
+bool content__set_title(struct content *c, const char *title);
+
+/**
+ * Retrieve title associated with content
+ *
+ * \param c Content to retrieve title from
+ * \return Pointer to title, or NULL if not found.
+ */
 const char *content__get_title(struct content *c);
+
+/**
+ * Retrieve status message associated with content
+ *
+ * \param c Content to retrieve status message from
+ * \return Pointer to status message, or NULL if not found.
+ */
 const char *content__get_status_message(struct content *c);
+
+/**
+ * Retrieve width of content
+ *
+ * \param c Content to retrieve width of
+ * \return Content width
+ */
 int content__get_width(struct content *c);
+
+/**
+ * Retrieve height of content
+ *
+ * \param c Content to retrieve height of
+ * \return Content height
+ */
 int content__get_height(struct content *c);
+
+/**
+ * Retrieve available width of content
+ *
+ * \param c content to get available width of.
+ * \return Available width of content.
+ */
 int content__get_available_width(struct content *c);
+
+/**
+ * Retrieve source of content.
+ *
+ * \param c    Content to retrieve source of.
+ * \param size Pointer to location to receive byte size of source.
+ * \return Pointer to source data.
+ */
 const char *content__get_source_data(struct content *c, unsigned long *size);
 
 /**
-- 
cgit v1.2.3