summaryrefslogtreecommitdiff
path: root/desktop
diff options
context:
space:
mode:
authorMichael Drake <michael.drake@codethink.co.uk>2017-04-28 12:09:58 +0100
committerMichael Drake <michael.drake@codethink.co.uk>2017-04-28 12:09:58 +0100
commitad3da6c1393ea69268f545e6581af668b5f337c9 (patch)
tree28fb6da810ee0d84a278506dbfd431bcedf31f7a /desktop
parent06baaa9f7c037d2aa9d9c67e0b9b07724372e0f0 (diff)
downloadnetsurf-ad3da6c1393ea69268f545e6581af668b5f337c9.tar.gz
netsurf-ad3da6c1393ea69268f545e6581af668b5f337c9.tar.bz2
Core hotlist: Improve hotlist_init documentation.
Diffstat (limited to 'desktop')
-rw-r--r--desktop/hotlist.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/desktop/hotlist.h b/desktop/hotlist.h
index a16b3e8ad..571f4de97 100644
--- a/desktop/hotlist.h
+++ b/desktop/hotlist.h
@@ -40,8 +40,11 @@ struct rect;
* be called before URLs can be added to the hotlist, and before the
* hotlist can be queried to ask if URLs are present in the hotlist.
*
+ * In read-only mode the hotlist can be modified, but changes will not
+ * persist over sessions.
+ *
* \param load_path The path to load hotlist from.
- * \param save_path The path to save hotlist to, or NULL for read-only.
+ * \param save_path The path to save hotlist to, or NULL for read-only mode.
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror hotlist_init(