annotate doc/html/api/event/onReload.md @ 15:8d74eeb81184

Docs: update documentation in the irccd JavaScript events
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 13:48:53 +0100
parents 1158cffe5a5e
children 904ee87bc808
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 event: onReload
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "Request to reload the plugin."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "function onReload()"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 This function is called when irccd instance reload a plugin. Thus, there are no IRC events that call this function.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 This function does nothing in the irccd internals, it just calls a function that you can use to reload some data. It
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 does not delete anything.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
15
8d74eeb81184 Docs: update documentation in the irccd JavaScript events
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
12 If you want to fully unload a plugin, use `irccdctl plugin-unload` then `irccdctl plugin-load`.