Doxygen cleanups

content/content.c

@@ -233,7 +233,8 @@ static void content_update_status(struct content *c)
  *
  * The textual status contained in the content is updated with given string.
  *
- * \param status_message  new textual status
+ * \param c The content to set status in.
+ * \param status_message new textual status
  */
 
 void content_set_status(struct content *c, const char *status_message)
@@ -723,11 +724,11 @@ void content_broadcast_errorcode(struct content *c, nserror errorcode)
 /**
  * A window containing the content has been opened.
  *
- * \param  c	   content that has been opened
- * \param  bw	   browser window containing the content
- * \param  page	   content of type CONTENT_HTML containing c, or 0 if not an
+ * \param h	 handle to content that has been opened
+ * \param bw	 browser window containing the content
+ * \param page   content of type CONTENT_HTML containing h, or 0 if not an
  *		   object within a page
- * \param  params  object parameters, or 0 if not an object
+ * \param params object parameters, or 0 if not an object
  *
  * Calls the open function for the content.
  */
@@ -1300,7 +1301,7 @@ bool content__is_locked(struct content *c)
 /**
  * Retrieve the low-level cache handle for a content
  *
- * \param h  Content to retrieve from
+ * \param c Content to retrieve from
  * \return Low-level cache handle
  */
 const llcache_handle *content_get_llcache_handle(struct content *c)

content/content.h

@@ -333,7 +333,7 @@ struct content_rfc5988_link *content_find_rfc5988_link(struct hlcache_handle *h,
  * \param h handle to the content to retrieve tyoe of.
  * \return Computed content type
  */
-content_type content_get_type(struct hlcache_handle *c);
+content_type content_get_type(struct hlcache_handle *h);
 
 /**
  * Retrieve mime-type of content

content/content_protected.h

@@ -198,7 +198,7 @@ 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.
+ * \param title The new title to set.
  * \return true on sucess else false.
  */
 bool content__set_title(struct content *c, const char *title);

content/fetchers.h

@@ -141,10 +141,10 @@ void fetcher_quit(void);
  * operation. The fallback to polled operation will only occour after
  * a timeout which introduces additional delay.
  *
- * \param read_fd_set[out] The fd set for read.
- * \param write_fd_set[out] The fd set for write.
- * \param except_fd_set[out] The fd set for exceptions.
- * \param maxfd[out] The highest fd number in the set or -1 if no fd available.
+ * \param[out] read_fd_set The fd set for read.
+ * \param[out] write_fd_set The fd set for write.
+ * \param[out] except_fd_set The fd set for exceptions.
+ * \param[out] maxfd The highest fd number in the set or -1 if no fd available.
  * \return NSERROR_OK on success or appropriate error code.
  */
 nserror fetcher_fdset(fd_set *read_fd_set, fd_set *write_fd_set, fd_set *except_fd_set, int *maxfd);

content/fetchers/curl.c

@@ -24,8 +24,7 @@
  *
  * This implementation uses libcurl's 'multi' interface.
  *
- * The CURL handles are cached in the curl_handle_ring. There are at most
- * ::max_cached_fetch_handles in this ring.
+ * The CURL handles are cached in the curl_handle_ring.
  */
 
 #include <assert.h>
@@ -814,7 +813,8 @@ static bool fetch_curl_process_headers(struct curl_fetch_info *f)
 /**
  * Handle a completed fetch (CURLMSG_DONE from curl_multi_info_read()).
  *
- * \param  curl_handle	curl easy handle of fetch
+ * \param curl_handle curl easy handle of fetch
+ * \param result The result code of the completed fetch.
  */
 static void fetch_curl_done(CURL *curl_handle, CURLcode result)
 {

content/fs_backing_store.c

@@ -152,7 +152,7 @@ struct store_state *storestate;
  * only valid until the next set_store_entry call.
  *
  * @param state The store state to use.
- * @param url The value used as the unique key to search entries for.
+ * @param ident The entry ident of the entry to store.
  * @param bse Pointer used to return value.
  * @return NSERROR_OK and bse updated on succes or NSERROR_NOT_FOUND
  *         if no entry coresponds to the url.
@@ -516,7 +516,11 @@ get_store_entry(struct store_state *state, nsurl *url, struct store_entry **bse)
  *
  * This creates a backing store entry in the entry table for a url.
  *
+ * @param state The store state to use.
  * @param url The value used as the unique key to search entries for.
+ * @param flags flags affecting how the entry is stored.
+ * @param data The data to store
+ * @param datalen The length of data in \a data
  * @param bse Pointer used to return value.
  * @return NSERROR_OK and \a bse updated on success or NSERROR_NOT_FOUND
  *         if no entry coresponds to the url.
@@ -600,15 +604,13 @@ set_store_entry(struct store_state *state,
 }
 
 
-
-
 /**
  * Open a file using a store ident.
  *
  * @param state The store state to use.
  * @param ident The identifier of the file to open.
  * @param flags The backing store flags.
- * @pram openflags The flags used with the open call.
+ * @param openflags The flags used with the open call.
  * @return An fd from the open call or -1 on error.
  */
 static int
@@ -1133,10 +1135,10 @@ store(nsurl *url,
 /**
  * Retrive an object from the backing store.
  *
- * @param url The url is used as the unique primary key for the data.
- * @param flags The flags to control how the object is stored.
- * @param data The objects data.
- * @param datalen The length of the \a data retrieved.
+ * @param[in] url The url is used as the unique primary key for the data.
+ * @param[in] flags The flags to control how the object is retrieved.
+ * @param[out] data_out The objects data.
+ * @param[out] datalen_out The length of the \a data retrieved.
  * @return NSERROR_OK on success or error code on faliure.
  */
 static nserror

content/llcache.c

@@ -917,8 +917,8 @@ static nserror llcache_object_add_to_list(llcache_object *object,
 /**
  * Determine the remaining lifetime of a cache object using the
  *
- * \param object  Object to consider
- * \return True if object is still fresh, false otherwise
+ * \param cd cache control data.
+ * \return The length of time remaining for the object or 0 if expired.
  */
 static int
 llcache_object_rfc2616_remaining_lifetime(const llcache_cache_control *cd)
@@ -2540,7 +2540,7 @@ static nserror llcache_object_notify_users(llcache_object *object)
 	 * State transitions and event emission for users.
 	 * Rows: user state. Cols: object state.
 	 *
-	 * User\Obj	INIT	HEADERS		DATA	COMPLETE
+	 * User - Obj	INIT	HEADERS		DATA	COMPLETE
 	 * INIT		 -	   T		 T*	   T*
 	 * HEADERS	 -	   -		 T	   T*
 	 * DATA		 -	   -		 M	   T

content/llcache.h

@@ -227,8 +227,7 @@ struct llcache_parameters {
 /**
  * Initialise the low-level cache
  *
- * \param cb  Query handler
- * \param pw  Pointer to query handler data
+ * \param parameters cache configuration parameters.
  * \return NSERROR_OK on success, appropriate error otherwise.
  */
 nserror llcache_initialise(const struct llcache_parameters *parameters);