Mercurial > irccd
annotate doc/src/api/event/onInvite.md @ 607:bb9771fb5f44
Docs: rework documentation
- Change directories,
- Remove handwritten manual pages.
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 08 Dec 2017 20:11:22 +0100 |
parents | doc/html/api/event/onInvite.md@904ee87bc808 |
children | ebdc614db066 |
rev | line source |
---|---|
0 | 1 --- |
2 event: onInvite | |
260
904ee87bc808
CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
3 js: true |
0 | 4 summary: "This event is called when someone is inviting you to a channel." |
5 synopsis: "function onInvite(server, origin, channel)" | |
6 arguments: | |
24
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
7 - "**server**: the current server," |
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
8 - "**origin**: who invited you," |
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
9 - "**channel**: on which channel you are invited to." |
0 | 10 --- |