Mercurial > irccd
changeset 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 | 6b41b6461813 |
| children | b3298e9d02c2 |
| files | doc/html/api/event/onChannelNotice.md doc/html/api/event/onJoin.md doc/html/api/event/onLoad.md doc/html/api/event/onMe.md doc/html/api/event/onMessage.md doc/html/api/event/onNotice.md doc/html/api/event/onPart.md doc/html/api/event/onQuery.md doc/html/api/event/onReload.md doc/html/api/event/onWhois.md |
| diffstat | 10 files changed, 18 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/api/event/onChannelNotice.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onChannelNotice.md Thu Feb 11 13:48:53 2016 +0100 @@ -4,7 +4,7 @@ synopsis: "function onChannelNotice(server, origin, channel, notice)" arguments: - "server, the current server," - - "origin, the one that sent the notice," + - "origin, the one who sent the notice," - "channel, the target channel," - "message, the notice message." ---
--- a/doc/html/api/event/onJoin.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onJoin.md Thu Feb 11 13:48:53 2016 +0100 @@ -1,9 +1,9 @@ --- event: onJoin -summary: "User join events, this function is called when someone join a channel." +summary: "User join events, this function is called when someone joins a channel." synopsis: "function onJoin(server, origin, channel)" arguments: - "server, the current server," - - "origin, the person that joined the channel," + - "origin, the person who joined the channel," - "channel, the channel the user has joined." ---
--- a/doc/html/api/event/onLoad.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onLoad.md Thu Feb 11 13:48:53 2016 +0100 @@ -1,5 +1,5 @@ --- event: onLoad -summary: "This function is called when irccd instance load a plugin. If this function raises an error, the script is not loaded." +summary: "This function is called when irccd instance load a plugin. If this function throws an error, the script is not loaded." synopsis: "function onLoad()" ---
--- a/doc/html/api/event/onMe.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onMe.md Thu Feb 11 13:48:53 2016 +0100 @@ -1,10 +1,10 @@ --- event: onMe -summary: "Action emote" +summary: "Action emote." synopsis: "function onMe(server, origin, channel, message)" arguments: - "server, the current server," - - "origin, the person that said something," + - "origin, the person who said something," - "channel, the channel," - "message, the message sent." ---
--- a/doc/html/api/event/onMessage.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onMessage.md Thu Feb 11 13:48:53 2016 +0100 @@ -4,7 +4,7 @@ synopsis: "function onMessage(server, origin, channel, message)" arguments: - "server, the current server," - - "origin, the person that said something," + - "origin, the person who said something," - "channel, the channel," - "message, the message sent." ---
--- a/doc/html/api/event/onNotice.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onNotice.md Thu Feb 11 13:48:53 2016 +0100 @@ -4,6 +4,6 @@ synopsis: "function onNotice(server, origin, notice)" arguments: - "server, the current server," - - "origin, the one that sent the notice," + - "origin, the one who sent the notice," - "message, the notice message." ---
--- a/doc/html/api/event/onPart.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onPart.md Thu Feb 11 13:48:53 2016 +0100 @@ -4,7 +4,7 @@ synopsis: "function onPart(server, origin, channel, reason)" arguments: - "server, the current server," - - "origin, the person that left the channel," + - "origin, the person who left the channel," - "channel, the channel," - "reason, an optional reason." ---
--- a/doc/html/api/event/onQuery.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onQuery.md Thu Feb 11 13:48:53 2016 +0100 @@ -4,6 +4,6 @@ synopsis: "function onQuery(server, origin, message)" arguments: - "server, the current server," - - "origin, the person that said something," + - "origin, the person who said something," - "message, the message sent." ---
--- a/doc/html/api/event/onReload.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onReload.md Thu Feb 11 13:48:53 2016 +0100 @@ -9,4 +9,4 @@ This function does nothing in the irccd internals, it just calls a function that you can use to reload some data. It does not delete anything. -If you want to fully unload a plugin, use `irccdctl unload` then `irccdctl load`. +If you want to fully unload a plugin, use `irccdctl plugin-unload` then `irccdctl plugin-load`.
--- a/doc/html/api/event/onWhois.md Thu Feb 11 13:40:12 2016 +0100 +++ b/doc/html/api/event/onWhois.md Thu Feb 11 13:48:53 2016 +0100 @@ -1,16 +1,16 @@ --- event: onWhois -summary: "This event is triggered when irccd get information from a user." +summary: "This event is triggered when irccd gets information about a user." synopsis: "function onWhois(server, info)" arguments: - "server, the current server," - "info, the whois information." --- -The info is a table with the following fields: +The info is an object with the following properties: -- **nickname**, the user nickname. -- **user**, the user name. -- **host**, the hostname. -- **realname**, the real name used. -- **channels**, an optional sequences of channels joined. + - **nickname**, the user nickname, + - **user**, the user name, + - **host**, the hostname, + - **realname**, the real name used, + - **channels**, an optional list of channels joined.