Diffstat (limited to 'content/fetchers/resource.h')
1 files changed, 18 insertions, 3 deletions
diff --git a/content/fetchers/resource.h b/content/fetchers/resource.h
index 6c590d390..8a6c230f5 100644
@@ -17,21 +17,36 @@
- * resource: URL method handler
+ * resource: URL method handler.
+ * The resource fetcher is intended to provide a flat uniform URL
+ * space for browser local resources referenced by URL. Using this
+ * scheme each frontend is only required to provide a single entry
+ * point to locate resources which can be accessed by the standard URL
+ * type scheme.
- * register the resource scheme.
+ * Register the resource scheme.
* should only be called from the fetch initialise
- * callback to translate resource to full url
+ * Callback to translate resource to full url.
+ * Transforms a resource: filename into a full URL. The returned URL
+ * is used as the target for a redirect. The caller takes ownership of
+ * the returned string including freeing it when finished with it.
+ * \param filename The filename 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.
char* gui_find_resource(const char *filename);