Mercurial > irccd
changeset 24:392778b6d3c9
Docs: arguments are now in bold, #423
line wrap: on
line diff
--- a/doc/html/api/event/onChannelMode.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onChannelMode.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,9 +3,9 @@ summary: "This event is triggered when someone changed the channel's mode." synopsis: "function onChannelMode(server, origin, channel, mode, arg)" arguments: - - "server, the current server," - - "origin, the person who changed the mode," - - "channel, the channel," - - "mode, the new mode," - - "arg, the mode argument, if supported." + - "**server**: the current server," + - "**origin**: the person who changed the mode," + - "**channel**: the channel," + - "**mode**: the new mode," + - "**arg**: the mode argument, if supported." ---
--- a/doc/html/api/event/onChannelNotice.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onChannelNotice.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "This callback is called when someone sent a notice on a channel." synopsis: "function onChannelNotice(server, origin, channel, notice)" arguments: - - "server, the current server," - - "origin, the one who sent the notice," - - "channel, the target channel," - - "message, the notice message." + - "**server**: the current server," + - "**origin**: the one who sent the notice," + - "**channel**: the target channel," + - "**message**: the notice message." ---
--- a/doc/html/api/event/onCommand.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onCommand.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,10 +3,10 @@ summary: "Execute special command." synopsis: "function onCommand(server, origin, channel, message)" arguments: - - "server, the current server," - - "origin, who invoked the command," - - "channel, the channel where the message comes from," - - "message, the real message, without the ! part." + - "**server**: the current server," + - "**origin**: who invoked the command," + - "**channel**: the channel where the message comes from," + - "**message**: the real message, without the ! part." --- Special commands are not real IRC events. They are called from channel messages with a specific syntax using a delimiter
--- a/doc/html/api/event/onConnect.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onConnect.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "This callback is called when the irccd instance successfully connect to a server." synopsis: "function onConnect(server)" arguments: - - "server, the current server" + - "**server**: the current server." ---
--- a/doc/html/api/event/onInvite.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onInvite.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "This event is called when someone is inviting you to a channel." synopsis: "function onInvite(server, origin, channel)" arguments: - - "server, the current server," - - "origin, who invited you," - - "channel, on which channel you are invited to." + - "**server**: the current server," + - "**origin**: who invited you," + - "**channel**: on which channel you are invited to." ---
--- a/doc/html/api/event/onJoin.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onJoin.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ 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 who joined the channel," - - "channel, the channel the user has joined." + - "**server**: the current server," + - "**origin**: the person who joined the channel," + - "**channel**: the channel the user has joined." ---
--- a/doc/html/api/event/onKick.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onKick.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,9 +3,9 @@ summary: "This event is triggered when someone has been kicked from a channel." synopsis: "function onKick(server, origin, channel, target, reason)" arguments: - - "server, the current server," - - "origin, who kicked the person," - - "channel, the channel," - - "target, the kicked person," - - "reason, an optional reason." + - "**server**: the current server," + - "**origin**: who kicked the person," + - "**channel**: the channel," + - "**target**: the kicked person," + - "**reason**: an optional reason." ---
--- a/doc/html/api/event/onMe.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onMe.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "Action emote." synopsis: "function onMe(server, origin, channel, message)" arguments: - - "server, the current server," - - "origin, the person who said something," - - "channel, the channel," - - "message, the message sent." + - "**server**: the current server," + - "**origin**: the person who said something," + - "**channel**: the channel," + - "**message**: the message sent." ---
--- a/doc/html/api/event/onMessage.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onMessage.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "This event is triggered when someone said something on a specific channel." synopsis: "function onMessage(server, origin, channel, message)" arguments: - - "server, the current server," - - "origin, the person who said something," - - "channel, the channel," - - "message, the message sent." + - "**server**: the current server," + - "**origin**: the person who said something," + - "**channel**: the channel," + - "**message**: the message sent." ---
--- a/doc/html/api/event/onMode.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onMode.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "This event is triggered when the server changed your mode." synopsis: "function onMode(server, origin, mode)" arguments: - - "server, the current server," - - "origin, the person who changed the mode," - - "mode, the new mode." + - "**server**: the current server," + - "**origin**: the person who changed the mode," + - "**mode**: the new mode." ---
--- a/doc/html/api/event/onNames.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onNames.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "This event is triggered when a list of names has come." synopsis: "function onNames(server, channel, list)" arguments: - - "server, he current server," - - "channel, which channel," - - "list, a sequence with all users." + - "**server**: he current server," + - "**channel**: which channel," + - "**list**: a sequence with all users." ---
--- a/doc/html/api/event/onNick.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onNick.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "This event is triggered when someone changed its nickname." synopsis: "function onNick(server, origin, nickname)" arguments: - - "server, the current server," - - "origin, the old nickname," - - "nickname, the new nickname." + - "**server**: the current server," + - "**origin**: the old nickname," + - "**nickname**: the new nickname." ---
--- a/doc/html/api/event/onNotice.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onNotice.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "This event is triggered when someone sent a notice to you." synopsis: "function onNotice(server, origin, notice)" arguments: - - "server, the current server," - - "origin, the one who sent the notice," - - "message, the notice message." + - "**server**: the current server," + - "**origin**: the one who sent the notice," + - "**message**: the notice message." ---
--- a/doc/html/api/event/onPart.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onPart.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "This event is triggered when someone has left a specific channel." synopsis: "function onPart(server, origin, channel, reason)" arguments: - - "server, the current server," - - "origin, the person who left the channel," - - "channel, the channel," - - "reason, an optional reason." + - "**server**: the current server," + - "**origin**: the person who left the channel," + - "**channel**: the channel," + - "**reason**: an optional reason." ---
--- a/doc/html/api/event/onQuery.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onQuery.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "This event is triggered when someone sent a private message to you." synopsis: "function onQuery(server, origin, message)" arguments: - - "server, the current server," - - "origin, the person who said something," - - "message, the message sent." + - "**server**: the current server," + - "**origin**: the person who said something," + - "**message**: the message sent." ---
--- a/doc/html/api/event/onQueryCommand.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onQueryCommand.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,9 +3,9 @@ summary: "Execute special command in query." synopsis: "function onQueryCommand(server, origin, message)" arguments: - - "server, the current server," - - "origin, who invoked the command," - - "message, the real message, without the ! part." + - "**server**: the current server," + - "**origin**: who invoked the command," + - "**message**: the real message, without the ! part." --- Synonym of [onCommand](@baseurl@/api/event/onCommand.html) but for queries.
--- a/doc/html/api/event/onTopic.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onTopic.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "This event is triggered when someone changed the channel's topic." synopsis: "function onTopic(server, origin, channel, topic)" arguments: - - "server, the current server," - - "origin, the person who changed the topic," - - "channel, the channel," - - "topic, the new topic (may be empty)." + - "**server**: the current server," + - "**origin**: the person who changed the topic," + - "**channel**: the channel," + - "**topic**: the new topic (may be empty)." ---
--- a/doc/html/api/event/onWhois.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/event/onWhois.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,14 +3,14 @@ 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." + - "**server**: the current server," + - "**info**: the whois information." --- 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 list 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.
--- a/doc/html/api/module/Irccd.Directory/function/find.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/function/find.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "Find an entry by a pattern or a regular expression." synopsis: "Irccd.Directory.find(path, pattern, recursive)" arguments: - - "path, the base path," - - "pattern, the regular expression or file name," - - "recursive, set to true to search recursively (Optional, default: false)." + - "**path**: the base path," + - "**pattern**: the regular expression or file name," + - "**recursive**: set to true to search recursively (Optional, default: false)." returns: "The path to the file or undefined on errors or not found." ---
--- a/doc/html/api/module/Irccd.Directory/function/mkdir.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/function/mkdir.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Create a directory specified by path. It will create needed subdirectories just like you have invoked `mkdir -p`." synopsis: "Irccd.Directory.mkdir(path, mode = 0700)" arguments: - - "path, the path to the directory," - - "mode, the mode, not available on all platforms." + - "**path**: the path to the directory," + - "**mode**: the mode, not available on all platforms." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.Directory/function/remove.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/function/remove.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "Remove the directory optionally recursively." synopsis: "Irccd.Directory.remove(path, recursive)" arguments: - - "path, the path to the directory," - - "recursive, recursively or not (Optional, default: false)." + - "**path**: the path to the directory," + - "**recursive**: recursively or not (Optional, default: false)." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.Directory/method/constructor.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/method/constructor.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "Open a directory." synopsis: "Irccd.Directory(path, flags) /* constructor */" arguments: - - "path, the path to the directory," - - "flags, the OR'ed flags: `Irccd.Directory.Dot`, `Irccd.Directory.DotDot` (Optional, default: none)" + - "**path**: the path to the directory," + - "**flags**: the OR'ed flags: `Irccd.Directory.Dot`, `Irccd.Directory.DotDot` (Optional, default: none)." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.Directory/method/find.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/method/find.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Synonym of [Irccd.Directory.find](@baseurl@/api/module/Irccd.Directory/function/find.html) but the path is taken from the directory object." synopsis: "Directory.prototype.find(pattern, recursive)" arguments: - - "pattern, the regular expression or file name," - - "recursive, set to true to search recursively (Optional, default: false)." + - "**pattern**: the regular expression or file name," + - "**recursive**: set to true to search recursively (Optional, default: false)." returns: "The path to the file or undefined on errors or not found" ---
--- a/doc/html/api/module/Irccd.Directory/method/remove.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/method/remove.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Synonym of [Irccd.Directory.remove](@baseurl@/api/module/Irccd.Directory/function/remove.html) but the path is taken from the directory object." synopsis: "Directory.prototype.remove(recursive)" arguments: - - "recursive, recursively or not (Optional, default: false)" + - "**recursive**: recursively or not (Optional, default: false)." throws: "Any exception on error" ---
--- a/doc/html/api/module/Irccd.ElapsedTimer/index.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.ElapsedTimer/index.md Tue Feb 16 13:36:46 2016 +0100 @@ -8,8 +8,8 @@ ## Methods -- [(constructor)](method/constructor.html) -- [elapsed](method/elapsed.html) -- [pause](method/pause.html) -- [reset](method/reset.html) -- [restart](method/restart.html) + - [(constructor)](method/constructor.html) + - [elapsed](method/elapsed.html) + - [pause](method/pause.html) + - [reset](method/reset.html) + - [restart](method/restart.html)
--- a/doc/html/api/module/Irccd.ElapsedTimer/method/elapsed.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.ElapsedTimer/method/elapsed.md Tue Feb 16 13:36:46 2016 +0100 @@ -2,5 +2,5 @@ method: elapsed summary: "Get the number of elapsed milliseconds." synopsis: "ElapsedTimer.prototype.elapsed()" -returns: "the elapsed time in milliseconds" +returns: "The elapsed time in milliseconds." ---
--- a/doc/html/api/module/Irccd.ElapsedTimer/method/restart.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.ElapsedTimer/method/restart.md Tue Feb 16 13:36:46 2016 +0100 @@ -1,6 +1,5 @@ --- method: restart -since: 2.0.0 summary: "Restart the timer without resetting the current elapsed time." synopsis: "ElapsedTimer.prototype.restart()" ---
--- a/doc/html/api/module/Irccd.File/function/basename.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/basename.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Return the file basename as specified in `basename(3)` C function." synopsis: "base = Irccd.File.basename(path)" arguments: - - "path, the path to the file." + - "**path**: the path to the file." returns: "The base name." ---
--- a/doc/html/api/module/Irccd.File/function/dirname.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/dirname.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Return the file directory name as specified in `dirname(3)` C function." synopsis: "path = Irccd.File.dirname(path)" arguments: - - "path, the path to the file." + - "**path**: the path to the file." returns: "The directory name." ---
--- a/doc/html/api/module/Irccd.File/function/exists.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/exists.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Check if the file exists." synopsis: "ret = Irccd.File.exists(path)" arguments: - - "path, the path to the file." + - "**path**: the path to the file." returns: "True if exists." throws: "Any exception if we don't have access." ---
--- a/doc/html/api/module/Irccd.File/function/remove.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/remove.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Remove the file at the specified path." synopsis: "Irccd.File.remove(path)" arguments: - - "path, the path to the file." + - "**path**: the path to the file." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.File/function/stat.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/stat.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Get file information at the specified path." synopsis: "info = Irccd.File.stat(path)" arguments: - - "path, the path to the file." + - "**path**: the path to the file." returns: "The stat information." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.File/index.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/index.md Tue Feb 16 13:36:46 2016 +0100 @@ -19,28 +19,28 @@ The following properties are defined: -- **SeekCur**: (int) seek from the current file position, -- **SeekEnd**: (int) seek from end of the file, -- **SeekSet**: (int) seek from beginning of the file. + - **SeekCur**: (int) seek from the current file position, + - **SeekEnd**: (int) seek from end of the file, + - **SeekSet**: (int) seek from beginning of the file. ## Functions -- [basename](function/basename.html) -- [dirname](function/dirname.html) -- [exists](function/exists.html) -- [remove](function/remove.html) -- [stat](function/stat.html) (Optional) + - [basename](function/basename.html) + - [dirname](function/dirname.html) + - [exists](function/exists.html) + - [remove](function/remove.html) + - [stat](function/stat.html) (Optional) ## Methods -- [(constructor)](method/constructor.html) -- [basename](method/basename.html) -- [close](method/close.html) -- [dirname](method/dirname.html) -- [read](method/read.html) -- [readline](method/readline.html) -- [remove](method/remove.html) -- [seek](method/seek.html) -- [stat](method/stat.html) (Optional) -- [tell](method/tell.html) -- [write](method/write.html) + - [(constructor)](method/constructor.html) + - [basename](method/basename.html) + - [close](method/close.html) + - [dirname](method/dirname.html) + - [read](method/read.html) + - [readline](method/readline.html) + - [remove](method/remove.html) + - [seek](method/seek.html) + - [stat](method/stat.html) (Optional) + - [tell](method/tell.html) + - [write](method/write.html)
--- a/doc/html/api/module/Irccd.File/method/constructor.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/constructor.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "Open a file specified by path with the specified mode." synopsis: "Irccd.File(path, mode) /* constructor */" arguments: - - "path, the path to the file," - - "mode, the mode string." + - "**path**: the path to the file," + - "**mode**: the mode string." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.File/method/read.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/read.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Read the specified amount of characters or the whole file." synopsis: "File.prototype.read(amount)" arguments: - - "amount, the amount of characters or -1 to read all (Optional, default: -1)." + - "**amount**: the amount of characters or -1 to read all (Optional, default: -1)." returns: "The string." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.File/method/seek.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/seek.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Sets the position in the file." synopsis: "File.prototype.seek(type, amount)" arguments: - - "type, the type of setting (`Irccd.File.SeekSet`, `Irccd.File.SeekCur`, `Irccd.File.SeekSet`)," - - "amount, the new offset." + - "**type**: the type of setting (`Irccd.File.SeekSet`, `Irccd.File.SeekCur`, `Irccd.File.SeekSet`)," + - "**amount**: the new offset." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.File/method/write.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/write.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Write some characters to the file." synopsis: "File.prototype.write(data)" arguments: - - "data, the character to write." + - "**data**: the character to write." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.Logger/function/debug.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Logger/function/debug.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Adds a debug message, this is only appended to the journal if irccd was compiled in Debug mode." synopsis: "Irccd.Logger.debug(message)" arguments: - - "message, the message." + - "**message**: the message." --- ## Remarks
--- a/doc/html/api/module/Irccd.Logger/function/info.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Logger/function/info.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Log something. The message is logged only if irccd is running with verbose messages enabled." synopsis: "Irccd.Logger.info(message)" arguments: - - "message, the message." + - "**message**: the message." ---
--- a/doc/html/api/module/Irccd.Logger/function/warning.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Logger/function/warning.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Log a warning. The message will always be logged." synopsis: "Irccd.Logger.warning(message)" arguments: - - "message, the message." + - "**message**: the message." ---
--- a/doc/html/api/module/Irccd.Plugin/function/info.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Plugin/function/info.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Get information about a plugin." synopsis: "Irccd.Plugin.info(name)" arguments: - - "name, the plugin identifier, if not specified the current plugin is selected." + - "**name**: the plugin identifier, if not specified the current plugin is selected." returns: "The plugin information or undefined if the plugin was not found." ---
--- a/doc/html/api/module/Irccd.Plugin/function/load.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Plugin/function/load.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Load a plugin by name. This function will search through the standard directories." synopsis: "Irccd.Plugin.load(name)" arguments: - - "name, the plugin identifier." + - "**name**: the plugin identifier." throws: - "Error on errors," - "ReferenceError if the plugin was not found."
--- a/doc/html/api/module/Irccd.Plugin/function/reload.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Plugin/function/reload.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Reload a plugin by name." synopsis: "Irccd.Plugin.reload(name)" arguments: - - "name, the plugin identifier." + - "**name**: the plugin identifier." throws: - "Error on errors," - "ReferenceError if the plugin was not found."
--- a/doc/html/api/module/Irccd.Plugin/function/unload.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Plugin/function/unload.md Tue Feb 16 13:36:46 2016 +0100 @@ -1,9 +1,9 @@ --- -function: runload +function: unload summary: "Unload a plugin by name." synopsis: "Irccd.Plugin.unload(name)" arguments: - - "name, the plugin identifier." + - "**name**: the plugin identifier." throws: - "Error on errors," - "ReferenceError if the plugin was not found."
--- a/doc/html/api/module/Irccd.Server/function/add.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/function/add.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Add a new server to the irccd instance." synopsis: "Irccd.Server.add(server)" arguments: - - "server, the server object to add." + - "**server**: the server object to add." ---
--- a/doc/html/api/module/Irccd.Server/function/find.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/function/find.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Find a server by name." synopsis: "server = Irccd.Server.find(name)" arguments: - - "name, the server name." + - "**name**: the server name." returns: "the server object or undefined if not found." ---
--- a/doc/html/api/module/Irccd.Server/function/remove.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/function/remove.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,9 @@ summary: "Remove a server from the irccd instance and disconnect it." synopsis: "Irccd.Server.remove(name)" arguments: - - "name, the server name." + - "**name**: the server name." --- -**Note**: Since the server object has `toString` method, you can just pass a server object as well. +## Remarks + +Since the server object has `toString` method, you can just pass a server object as well.
--- a/doc/html/api/module/Irccd.Server/method/cmode.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/cmode.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Change the mode of the specified channel." synopsis: "Server.prototype.cmode(channel, mode)" arguments: - - "channel, the channel target," - - "mode, the mode." + - "**channel**: the channel target," + - "**mode**: the mode." ---
--- a/doc/html/api/module/Irccd.Server/method/cnotice.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/cnotice.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Send a message notice on a channel." synopsis: "Server.prototype.cnotice(channel, message)" arguments: - - "channel, the target channel," - - "message, the message." + - "**channel**: the target channel," + - "**message**: the message." ---
--- a/doc/html/api/module/Irccd.Server/method/constructor.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/constructor.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,25 +3,25 @@ summary: "Construct a new server" synopsis: "Irccd.Server(params) /* constructor */" arguments: - - "params, parameters." + - "**params**: parameters." --- The params argument may have the following properties: -- **name**: the name, -- **host**: the host, -- **ipv6**: true to use ipv6, (Optional: default false) -- **port**: the port number, (Optional: default 6667) -- **password**: the password, (Optional: default none) -- **channels**: array of channels (Optiona: default empty) -- **ssl**: true to use ssl, (Optional: default false) -- **sslVerify**: true to verify (Optional: default true) -- **nickname**: "nickname", (Optional, default: irccd) -- **username**: "user name", (Optional, default: irccd) -- **realname**: "real name", (Optional, default: IRC Client Daemon) -- **commandChar**: "!", (Optional, the command char, default: "!") + - **name**: the name, + - **host**: the host, + - **ipv6**: true to use ipv6, (Optional: default false) + - **port**: the port number, (Optional: default 6667) + - **password**: the password, (Optional: default none) + - **channels**: array of channels (Optiona: default empty) + - **ssl**: true to use ssl, (Optional: default false) + - **sslVerify**: true to verify (Optional: default true) + - **nickname**: "nickname", (Optional, default: irccd) + - **username**: "user name", (Optional, default: irccd) + - **realname**: "real name", (Optional, default: IRC Client Daemon) + - **commandChar**: "!", (Optional, the command char, default: "!") -Example +## Example ````javascript var s = new Irccd.Server({
--- a/doc/html/api/module/Irccd.Server/method/info.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/info.md Tue Feb 16 13:36:46 2016 +0100 @@ -7,12 +7,12 @@ The returned object has the following fields: -- **name**: (string) the server unique name, -- **host**: (string) the host name, -- **port**: (int) the port number, -- **ssl**: (bool) true if using ssl, -- **sslVerify**: (bool) true if ssl was verified, -- **channels**: (string list) an array of all channels, -- **realname**: (string) the current real name, -- **username**: (string) the user name, -- **nickname**: (string) the current nickname. + - **name**: (string) the server unique name, + - **host**: (string) the host name, + - **port**: (int) the port number, + - **ssl**: (bool) true if using ssl, + - **sslVerify**: (bool) true if ssl was verified, + - **channels**: (string list) an array of all channels, + - **realname**: (string) the current real name, + - **username**: (string) the user name, + - **nickname**: (string) the current nickname.
--- a/doc/html/api/module/Irccd.Server/method/invite.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/invite.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Invite the specified target on the channel." synopsis: "Server.prototype.invite(target, channel)" arguments: - - "target, the target to invite" - - "channel, the channel" + - "**target**: the target to invite," + - "**channel**: the channel." ---
--- a/doc/html/api/module/Irccd.Server/method/join.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/join.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Join the specified channel, the password is optional." synopsis: "Server.prototype.join(channel, password)" arguments: - - "channel, the channel to join," - - "password, an optional password." + - "**channel**: the channel to join," + - "**password**: an optional password." ---
--- a/doc/html/api/module/Irccd.Server/method/kick.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/kick.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,7 +3,7 @@ summary: "Kick the specified target from the channel, the reason is optional." synopsis: "Server.prototype.kick(nickname, channel, reason)" arguments: - - "nickname, the person to kick," - - "channel, from which channel," - - "reason, an optional reason." + - "**nickname**: the person to kick," + - "**channel**: from which channel," + - "**reason**: an optional reason." ---
--- a/doc/html/api/module/Irccd.Server/method/me.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/me.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Send an action emote." synopsis: "Server.prototype.me(target, message)" arguments: - - "target, a nick or a channel," - - "message, the message to send." + - "**target**: a nick or a channel," + - "**message**: the message to send." ---
--- a/doc/html/api/module/Irccd.Server/method/message.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/message.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Send a message to the specified target or channel." synopsis: "Server.prototype.message(target, message)" arguments: - - "target, the target," - - "message, the message to send." + - "**target**: the target," + - "**message**: the message to send." ---
--- a/doc/html/api/module/Irccd.Server/method/mode.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/mode.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Set the irccd's user mode." synopsis: "Server.prototype.mode(mode)" arguments: - - "mode, the new mode" + - "**mode**: the new mode." ---
--- a/doc/html/api/module/Irccd.Server/method/names.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/names.md Tue Feb 16 13:36:46 2016 +0100 @@ -1,8 +1,7 @@ --- method: names +summary: "Get the list of names. This function will generate the onNames event." synopsis: "Server.prototype.names(channel)" arguments: - - "channel, the channel name." + - "**channel**: the channel name." --- - -Get the list of names. This function will generate the onNames event.
--- a/doc/html/api/module/Irccd.Server/method/nick.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/nick.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Change irccd's nickname." synopsis: "Server.prototype.nick(nickname)" arguments: - - "nickname, the new nickname." + - "**nickname**: the new nickname." ---
--- a/doc/html/api/module/Irccd.Server/method/notice.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/notice.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Send a private notice to the specified target." synopsis: "Server.prototype.notice(nickname, message)" arguments: - - "nickname, the target nickname," - - "message, the notice message." + - "**nickname**: the target nickname," + - "**message**: the notice message." ---
--- a/doc/html/api/module/Irccd.Server/method/part.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/part.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "Leave the specified channel, the reason is optional." synopsis: "Server.prototype.part(channel, reason)" arguments: - - "channel, the channel to leave," - - "reason, an optional reason." + - "**channel**: the channel to leave," + - "**reason**: an optional reason." --- Not all IRC servers support giving a reason to leave a channel, do not specify it if this is a concern.
--- a/doc/html/api/module/Irccd.Server/method/topic.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/topic.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Change the topic of the specified channel." synopsis: "Server.prototype.topic(channel, topic)" arguments: - - "channel, the channel," - - "topic, the new topic." + - "**channel**: the channel," + - "**topic**: the new topic." ---
--- a/doc/html/api/module/Irccd.Server/method/whois.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/method/whois.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Get whois information from a user. The function will generate [onWhois](@baseurl@/api/event/onWhois.html) event." synopsis: "Server.prototype.whois(target)" arguments: - - "target, the target" + - "**target**: the target." ---
--- a/doc/html/api/module/Irccd.System/function/env.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/env.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Get a environment variable." synopsis: "home = Irccd.System.env(name)" arguments: - - "name, the environment variable name." + - "**name**: the environment variable name." returns: "The variable or an empty string." ---
--- a/doc/html/api/module/Irccd.System/function/exec.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/exec.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Execute a system command." synopsis: "Irccd.System.exec(cmd)" arguments: - - "cmd, the command to execute." + - "**cmd**: the command to execute." ---
--- a/doc/html/api/module/Irccd.System/function/popen.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/popen.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,8 +3,8 @@ summary: "Wrapper for `popen(3)` if the function is available." synopsis: "Irccd.System.popen(cmd, mode) /* optional */" arguments: - - "cmd, the command to execute," - - "mode, the mode (e.g. `r`)." + - "**cmd**: the command to execute," + - "**mode**: the mode (e.g. `r`)." returns: "An [Irccd.File](@baseurl@/api/module/Irccd.File/index.html) object." throws: "Irccd.SystemError on failures." ---
--- a/doc/html/api/module/Irccd.System/function/sleep.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/sleep.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Sleep for seconds. Suspend the execution thread." synopsis: "Irccd.System.sleep(sec)" arguments: - - "sec, the number of seconds." + - "**sec**: the number of seconds." ---
--- a/doc/html/api/module/Irccd.System/function/usleep.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/usleep.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,5 +3,5 @@ summary: "Sleep for milliseconds. Suspend the execution thread." synopsis: "Irccd.System.usleep(msec)" arguments: - - "msec, the number of milliseconds." + - "**msec**: the number of milliseconds." ---
--- a/doc/html/api/module/Irccd.System/index.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.System/index.md Tue Feb 16 13:36:46 2016 +0100 @@ -5,8 +5,6 @@ ## Usage -System inspection. - Use this module if you want to inspect the system independently. ## Functions
--- a/doc/html/api/module/Irccd.Timer/index.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Timer/index.md Tue Feb 16 13:36:46 2016 +0100 @@ -10,11 +10,11 @@ The following properties are defined: - - **Single**, (int) the timer is single-shot, - - **Repeat**, (int) the timer is looping. + - **Single**: (int) the timer is single-shot, + - **Repeat**: (int) the timer is looping. ## Methods -- [(constructor)](method/constructor.html) -- [start](method/start.html) -- [stop](method/stop.html) + - [(constructor)](method/constructor.html) + - [start](method/start.html) + - [stop](method/stop.html)
--- a/doc/html/api/module/Irccd.Timer/method/constructor.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Timer/method/constructor.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,9 +3,9 @@ summary: "Create a new timer object." synopsis: "Irccd.Timer(type, delay, callback) /* constructor */" arguments: - - "type, type of timer (`Irccd.Timer.Repeat` or `Irccd.Timer.Single`)," - - "delay, the interval in milliseconds," - - "callback, the function to call." + - "**type**: type of timer (`Irccd.Timer.Repeat` or `Irccd.Timer.Single`)," + - "**delay**: the interval in milliseconds," + - "**callback**: the function to call." --- ## Example
--- a/doc/html/api/module/Irccd.Unicode/function/isDigit.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isDigit.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Check if the unicode character is a digit." synopsis: "ret = Irccd.Unicode.isDigit(code)" arguments: - - "code, the code point." + - "**code**: the code point." returns: "True if digit." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isLetter.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isLetter.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Check if the unicode character is a letter." synopsis: "ret = Irccd.Unicode.isLetter(code)" arguments: - - "code, the code point." + - "**code**: the code point." returns: "True if letter." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isLower.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isLower.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Check if the unicode character is lower case." synopsis: "ret = Irccd.Unicode.isLower(code)" arguments: - - "code, the code point." + - "**code**: the code point." returns: "True if lower case." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isSpace.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isSpace.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Check if the unicode character is a space." synopsis: "ret = Irccd.Unicode.isSpace(code)" arguments: - - "code, the code point." + - "**code**: the code point." returns: "True if space." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isTitle.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isTitle.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Check if the unicode character is title case." synopsis: "ret = Irccd.Unicode.isTitle(code)" arguments: - - "code, the code point." + - "**code**: the code point." returns: "True if title case." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isUpper.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isUpper.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Check if the unicode character is upper case." synopsis: "ret = Irccd.Unicode.isUpper(code)" arguments: - - "code, the code point." + - "**code**: the code point." returns: "True if upper case." ---
--- a/doc/html/api/module/Irccd.Unicode/index.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/index.md Tue Feb 16 13:36:46 2016 +0100 @@ -8,9 +8,9 @@ ## Functions -- [isDigit](function/isDigit.html) -- [isLetter](function/isLetter.html) -- [isLower](function/isLower.html) -- [isSpace](function/isSpace.html) -- [isTitle](function/isTitle.html) -- [isUpper](function/isUpper.html) + - [isDigit](function/isDigit.html) + - [isLetter](function/isLetter.html) + - [isLower](function/isLower.html) + - [isSpace](function/isSpace.html) + - [isTitle](function/isTitle.html) + - [isUpper](function/isUpper.html)
--- a/doc/html/api/module/Irccd.Util/function/format.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Util/function/format.md Tue Feb 16 13:36:46 2016 +0100 @@ -5,12 +5,11 @@ specification. synopsis: "str = Irccd.Util.format(input, params)" arguments: - - "input, the text to update," - - "params, the parameters." + - "**input**: the text to update," + - "**params**: the parameters." returns: "The converted text." --- - ## Example Replaces the keyword `message` and formats it bold and red.
--- a/doc/html/api/module/Irccd.Util/function/splithost.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Util/function/splithost.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Extract the host from a user, for instance with foo!~foo@localhost, localhost will be returned." synopsis: "host = Irccd.Util.splithost(user)" arguments: - - "user, the user to split." + - "**user**: the user to split." returns: "The hostname." ---
--- a/doc/html/api/module/Irccd.Util/function/splituser.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Util/function/splituser.md Tue Feb 16 13:36:46 2016 +0100 @@ -3,6 +3,6 @@ summary: "Extract the nickname, for instance with foo!~foo@localhost, foo will be returned." synopsis: "nick = Irccd.Util.splituser(user)" arguments: - - "user, the user to split." + - "**user**: the user to split." returns: "The nickname." ---
--- a/doc/html/api/module/Irccd.Util/index.md Sun Feb 14 16:15:48 2016 +0100 +++ b/doc/html/api/module/Irccd.Util/index.md Tue Feb 16 13:36:46 2016 +0100 @@ -8,6 +8,6 @@ ## Functions -- [format](function/format.html) -- [splituser](function/splituser.html) -- [splithost](function/splithost.html) + - [format](function/format.html) + - [splituser](function/splituser.html) + - [splithost](function/splithost.html)