summaryrefslogtreecommitdiff
path: root/include/netsurf
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2021-02-26 13:39:50 +0000
committerVincent Sanders <vince@kyllikki.org>2021-02-26 13:40:09 +0000
commit5e31f045a03753e2d65c3d65ef27d10919648eff (patch)
treec41f27f4898f618e78135cb8f0e073a4db04f9e7 /include/netsurf
parente9f29a1002046992b347b9c1adfe07677d12e6fb (diff)
downloadnetsurf-5e31f045a03753e2d65c3d65ef27d10919648eff.tar.gz
netsurf-5e31f045a03753e2d65c3d65ef27d10919648eff.tar.bz2
Improve some documentation comments
Diffstat (limited to 'include/netsurf')
-rw-r--r--include/netsurf/fetch.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/netsurf/fetch.h b/include/netsurf/fetch.h
index 6e6d653ee..30b204868 100644
--- a/include/netsurf/fetch.h
+++ b/include/netsurf/fetch.h
@@ -49,15 +49,15 @@ struct gui_fetch_table {
/**
* Translate resource to full url.
*
- * @note Only used in resource fetcher
+ * @note Only used in resource protocol fetcher
*
- * Transforms a resource: path into a full URL. The returned URL
+ * Transforms a resource protocol path into a full URL. The returned URL
* is used as the target for a redirect. The caller takes ownership of
* the returned nsurl including unrefing it when finished with it.
*
* \param path The path of the resource to locate.
- * \return A string containing the full URL of the target object or
- * NULL if no suitable resource can be found.
+ * \return A netsurf url object containing the full URL of the resource
+ * path or NULL if a suitable resource URL can not be generated.
*/
struct nsurl* (*get_resource_url)(const char *path);