Core hotlist: Improve hotlist_init documentation.

This commit is contained in:
Michael Drake 2017-04-28 12:09:58 +01:00
parent 06baaa9f7c
commit ad3da6c139
1 changed files with 4 additions and 1 deletions

View File

@ -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(