Mercurial > irccd
changeset 13:070a1ece2af6
Docs: fix various errors in JavaScript API
line wrap: on
line diff
--- a/doc/html/api/module/Irccd.Directory/function/mkdir.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/function/mkdir.md Thu Feb 11 22:02:57 2016 +0100 @@ -4,6 +4,6 @@ synopsis: "Irccd.Directory.mkdir(path, mode = 0700)" arguments: - "path, the path to the directory," - - "mode, the mode, not available on all platforms" + - "mode, the mode, not available on all platforms." throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.Directory/function/remove.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/function/remove.md Thu Feb 11 22:02:57 2016 +0100 @@ -8,6 +8,8 @@ throws: "Any exception on error." --- -<div class="alert alert-warning" role="alert"> -**Warning**: use this function with care! +## Remarks + +<div class="alert alert-danger" role="alert"> +**Danger**: use this function with care! </div>
--- a/doc/html/api/module/Irccd.Directory/method/constructor.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/method/constructor.md Thu Feb 11 22:02:57 2016 +0100 @@ -4,7 +4,7 @@ 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)" + - "flags, the OR'ed flags: `Irccd.Directory.Dot`, `Irccd.Directory.DotDot` (Optional, default: none)" throws: "Any exception on error." --- @@ -22,11 +22,9 @@ try { var d = new Irccd.Directory("/usr/share/games"); - for (var i = 0; i < d.count; ++i) { - if (d.entries[i].type == Irccd.Directory.TypeFile) { + for (var i = 0; i < d.count; ++i) + if (d.entries[i].type == Irccd.Directory.TypeFile) // use d.entries[i].name which is a file. - } - } } catch (e) { // Use the error }
--- a/doc/html/api/module/Irccd.Directory/method/find.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/method/find.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,6 +1,6 @@ --- method: find -summary: "Synonym of `Directory.find(path, pattern, recursive)` but the path is taken from the directory object." +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,"
--- a/doc/html/api/module/Irccd.Directory/method/remove.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Directory/method/remove.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,6 +1,6 @@ --- method: remove -summary: "Synonym of Directory.remove(recursive) but the path is taken from the directory object." +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)"
--- a/doc/html/api/module/Irccd.File/function/basename.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/basename.md Thu Feb 11 22:02:57 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 Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/dirname.md Thu Feb 11 22:02:57 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." ---- \ No newline at end of file +---
--- a/doc/html/api/module/Irccd.File/function/exists.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/exists.md Thu Feb 11 22:02:57 2016 +0100 @@ -4,6 +4,6 @@ synopsis: "ret = Irccd.File.exists(path)" arguments: - "path, the path to the file." -returns: "true if exists" +returns: "True if exists." throws: "Any exception if we don't have access." ---- \ No newline at end of file +---
--- a/doc/html/api/module/Irccd.File/function/remove.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/remove.md Thu Feb 11 22:02:57 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." ---- \ No newline at end of file +---
--- a/doc/html/api/module/Irccd.File/function/stat.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/stat.md Thu Feb 11 22:02:57 2016 +0100 @@ -4,14 +4,10 @@ synopsis: "info = Irccd.File.stat(path)" arguments: - "path, the path to the file." -returns: "The stats information" +returns: "The stat information." throws: "Any exception on error." --- -<div class="alert alert-warning" role="alert"> -**Warning**: this function is optional and may not be available on your system. -</div> - The returned object may have the following properties if they are available on your system: - **atime**: (int) the last access time, @@ -27,3 +23,9 @@ - **rdev**: (int), - **size**: (int) the file size, - **uid**: (int) the user. + +## Remarks + +<div class="alert alert-warning" role="alert"> +**Warning**: this function is optional and may not be available on your system. +</div>
--- a/doc/html/api/module/Irccd.File/index.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/index.md Thu Feb 11 22:02:57 2016 +0100 @@ -9,6 +9,8 @@ For convenience, some functions are available as free-functions and some as object methods. +## Remarks + <div class="alert alert-warning" role="alert"> **Warning**: the stat function and method are optional and may not be available on your system. </div>
--- a/doc/html/api/module/Irccd.File/method/basename.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/basename.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,7 +1,6 @@ --- method: basename -summary: "Synonym of `Irccd.File.basename(path)` but with the path from the file." +summary: "Synonym of [Irccd.File.basename](@baseurl@/api/module/Irccd.File/function/basename.html) but with the path from the file." synopsis: "File.prototype.basename()" returns: "The base name." -throws: "Any exception on error" ---- \ No newline at end of file +---
--- a/doc/html/api/module/Irccd.File/method/constructor.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/constructor.md Thu Feb 11 22:02:57 2016 +0100 @@ -4,14 +4,13 @@ synopsis: "Irccd.File(path, mode) /* constructor */" arguments: - "path, the path to the file," - - "mode, the mode, can be one of [abrwt]" -throws: "Any exception on error" + - "mode, the mode string." +throws: "Any exception on error." --- -The mode string understands the following characters: +## Mode - - **a**: append to the end of file, - - **b**: open in binary mode, - - **r**: open for reading, - - **w**: open for writing, - - **t**: truncate the file. \ No newline at end of file +The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information +about the mode string. + +[fopen]: http://en.cppreference.com/w/cpp/io/c/fopen
--- a/doc/html/api/module/Irccd.File/method/dirname.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/dirname.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,7 +1,6 @@ --- method: dirname -summary: "Synonym of `Irccd.File.dirname(path)` but with the path from the file." -synopsis: "" -arguments: +summary: "Synonym of [Irccd.File.dirname](@baseurl@/api/module/Irccd.File/function/dirname.html) but with the path from the file." +synopsis: "File.prototype.dirname()" returns: "The directory name." ---- \ No newline at end of file +---
--- a/doc/html/api/module/Irccd.File/method/readline.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/readline.md Thu Feb 11 22:02:57 2016 +0100 @@ -3,5 +3,5 @@ summary: "Read the next line available." synopsis: "File.prototype.readline()" returns: "The next line or undefined if eof." -throws: "Any exception on error" +throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.File/method/seek.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/seek.md Thu Feb 11 22:02:57 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)," + - "type, the type of setting (`Irccd.File.SeekSet`, `Irccd.File.SeekCur`, `Irccd.File.SeekSet`)," - "amount, the new offset." -throws: "Any exception on error" +throws: "Any exception on error." ---
--- a/doc/html/api/module/Irccd.File/method/stat.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/stat.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,11 +1,13 @@ --- method: stat -summary: "Synonym of [File.stat](@baseurl@/api/module/Irccd.File/function/stat.html) but with the path from the file." +summary: "Synonym of [Irccd.File.stat](@baseurl@/api/module/Irccd.File/function/stat.html) but with the path from the file." synopsis: "File.prototype.stat()" -returns: "The stat information" -throws: "Any exception on error" +returns: "The stat information." +throws: "Any exception on error." --- +## Remarks + <div class="alert alert-warning" role="alert"> **Warning**: this method is optional and may not be available on your system. </div>
--- a/doc/html/api/module/Irccd.Logger/function/debug.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Logger/function/debug.md Thu Feb 11 22:02:57 2016 +0100 @@ -6,4 +6,6 @@ - "message, the message." --- +## Remarks + This function targets irccd developers, the end user should not use it.
--- a/doc/html/api/module/Irccd.Logger/index.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Logger/index.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,24 +1,21 @@ --- module: Irccd.Logger -summary: "Logging functions" +summary: "Logging functions." --- ## Usage -This module must be used to log something. It will add messages to the logging -system configured in the irccd.conf file. +This module must be used to log something. It will add messages to the logging system configured in the irccd.conf file. -For instance, if user has chosen to log into syslog, this module will log at -syslog too. +For instance, if user has chosen to log into syslog, this module will log at syslog too. -Any plugin can log messages, the message will be prepended by the plugin -name to be easily identifiable. +Any plugin can log messages, the message will be prepended by the plugin name to be easily identifiable. ## Functions -- [debug](function/debug.html) -- [info](function/info.html) -- [warning](function/warning.html) + - [debug](function/debug.html) + - [info](function/info.html) + - [warning](function/warning.html) ## Example
--- a/doc/html/api/module/Irccd.Server/function/list.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/function/list.md Thu Feb 11 22:02:57 2016 +0100 @@ -5,7 +5,7 @@ returns: "the table of all servers." --- -Example: +## Example ````javascript var table = Irccd.Server.list();
--- a/doc/html/api/module/Irccd.Server/index.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Server/index.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,6 +1,6 @@ --- module: Irccd.Server -summary: "Server management" +summary: "Server management." --- ## Usage @@ -10,27 +10,27 @@ ## Functions -- [add](function/add.html) -- [find](function/find.html) -- [list](function/list.html) -- [remove](function/remove.html) + - [add](function/add.html) + - [find](function/find.html) + - [list](function/list.html) + - [remove](function/remove.html) ## Methods -- [(constructor)](method/constructor.html) -- [cmode](method/cmode.html) -- [cnotice](method/cnotice.html) -- [info](method/info.html) -- [invite](method/invite.html) -- [join](method/join.html) -- [kick](method/kick.html) -- [me](method/me.html) -- [message](method/message.html) -- [mode](method/mode.html) -- [names](method/names.html) -- [nick](method/nick.html) -- [notice](method/notice.html) -- [part](method/part.html) -- [topic](method/topic.html) -- [whois](method/whois.html) -- [toString](method/toString.html) + - [(constructor)](method/constructor.html) + - [cmode](method/cmode.html) + - [cnotice](method/cnotice.html) + - [info](method/info.html) + - [invite](method/invite.html) + - [join](method/join.html) + - [kick](method/kick.html) + - [me](method/me.html) + - [message](method/message.html) + - [mode](method/mode.html) + - [names](method/names.html) + - [nick](method/nick.html) + - [notice](method/notice.html) + - [part](method/part.html) + - [topic](method/topic.html) + - [whois](method/whois.html) + - [toString](method/toString.html)
--- a/doc/html/api/module/Irccd.System/function/env.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/env.md Thu Feb 11 22:02:57 2016 +0100 @@ -4,5 +4,5 @@ synopsis: "home = Irccd.System.env(name)" arguments: - "name, the environment variable name." -returns: "The variable or an empty string" +returns: "The variable or an empty string." ---
--- a/doc/html/api/module/Irccd.System/function/exec.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/exec.md Thu Feb 11 22:02:57 2016 +0100 @@ -3,5 +3,5 @@ summary: "Execute a system command." synopsis: "Irccd.System.exec(cmd)" arguments: - - "cmd, the command to execute" ---- \ No newline at end of file + - "cmd, the command to execute." +---
--- a/doc/html/api/module/Irccd.System/function/home.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/home.md Thu Feb 11 22:02:57 2016 +0100 @@ -2,5 +2,5 @@ function: home summary: "Get the home directory. This function should be used with care, plugin should not use user's home to store files." synopsis: "home = Irccd.System.home()" -returns: "The user home directory" +returns: "The user home directory." ---
--- a/doc/html/api/module/Irccd.System/function/name.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/name.md Thu Feb 11 22:02:57 2016 +0100 @@ -2,5 +2,5 @@ function: name summary: "Get the operating system name. Usually Windows, FreeBSD, Linux and such." synopsis: "name = Irccd.System.name()" -returns: "The operating system name" +returns: "The operating system name." ---
--- a/doc/html/api/module/Irccd.System/function/popen.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/popen.md Thu Feb 11 22:02:57 2016 +0100 @@ -4,11 +4,13 @@ synopsis: "Irccd.System.popen(cmd, mode) /* optional */" arguments: - "cmd, the command to execute," - - "mode, the mode (e.g. r)." -returns: "A Irccd.File object." + - "mode, the mode (e.g. `r`)." +returns: "An [Irccd.File](@baseurl@/api/module/Irccd.File/index.html) object." throws: "Irccd.SystemError on failures." --- +## Remarks + <div class="alert alert-warning" role="alert"> **Warning**: this function is optional and may not be available on your system. </div>
--- a/doc/html/api/module/Irccd.System/function/ticks.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/ticks.md Thu Feb 11 22:02:57 2016 +0100 @@ -2,5 +2,5 @@ function: ticks summary: "Get the time spent from start. Get how many milliseconds spent since the irccd startup." synopsis: "msec = Irccd.System.ticks()" -returns: "The number of milliseconds" +returns: "The number of milliseconds." ---
--- a/doc/html/api/module/Irccd.System/index.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.System/index.md Thu Feb 11 22:02:57 2016 +0100 @@ -1,6 +1,6 @@ --- module: Irccd.System -summary: "System inspection" +summary: "System inspection." --- ## Usage @@ -11,13 +11,13 @@ ## Functions -- [env](function/env.html) -- [exec](function/exec.html) -- [home](function/home.html) -- [name](function/name.html) -- [popen](function/popen.html) (Optional) -- [sleep](function/sleep.html) -- [ticks](function/ticks.html) -- [uptime](function/uptime.html) -- [usleep](function/usleep.html) -- [version](function/version.html) + - [env](function/env.html) + - [exec](function/exec.html) + - [home](function/home.html) + - [name](function/name.html) + - [popen](function/popen.html) (Optional) + - [sleep](function/sleep.html) + - [ticks](function/ticks.html) + - [uptime](function/uptime.html) + - [usleep](function/usleep.html) + - [version](function/version.html)
--- a/doc/html/api/module/Irccd.Timer/method/constructor.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Timer/method/constructor.md Thu Feb 11 22:02:57 2016 +0100 @@ -3,8 +3,8 @@ 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," + - "type, type of timer (`Irccd.Timer.Repeat` or `Irccd.Timer.Single`)," + - "delay, the interval in milliseconds," - "callback, the function to call." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isDigit.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isDigit.md Thu Feb 11 22:02:57 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" -returns: "true if digit." + - "code, the code point." +returns: "True if digit." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isLetter.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isLetter.md Thu Feb 11 22:02:57 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" -returns: "true if letter." + - "code, the code point." +returns: "True if letter." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isLower.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isLower.md Thu Feb 11 22:02:57 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" -returns: "true if lower case." + - "code, the code point." +returns: "True if lower case." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isSpace.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isSpace.md Thu Feb 11 22:02:57 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" -returns: "true if space." + - "code, the code point." +returns: "True if space." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isTitle.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isTitle.md Thu Feb 11 22:02:57 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" -returns: "- true if title case." + - "code, the code point." +returns: "True if title case." ---
--- a/doc/html/api/module/Irccd.Unicode/function/isUpper.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Unicode/function/isUpper.md Thu Feb 11 22:02:57 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" -returns: "true if upper case." + - "code, the code point." +returns: "True if upper case." ---
--- a/doc/html/api/module/Irccd.Util/function/format.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Util/function/format.md Thu Feb 11 22:02:57 2016 +0100 @@ -5,8 +5,9 @@ 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." --- @@ -25,27 +26,34 @@ Be very careful when you use this function with untrusted input. -<div class="alert alert-danger" role="alert"> -**Bad code**: Do never pass untrusted content (e.g. user message) as input parameter. For example, the following code is terribly dangerous: -</div> - +<div class="panel panel-danger"> + <div class="panel-heading"> +**Bad code:** Do never pass untrusted content (e.g. user message) as input parameter. For example, the following code +is terribly dangerous: + </div> + <div class="panel-body"> ````javascript function onMessage(server, channel, origin, message) { - server.message(channel, Irccd.Util.format("%{red}" + input %{}"); + server.message(channel, Irccd.Util.format("@{red}" + message + "@{}"); } ```` -If a user write a message like `${HOME}`, it will prints the user home directory, which is a high security issue +If a user sends a message like `${HOME}`, it will prints the user home directory, which is a high security issue if you have environment variables with passwords. - -<div class="alert alert-success"> -**Correct code**: Instead, always use a literal string using a replacement with the user input + </div> </div> +<div class="panel panel-success"> + <div class="panel-heading"> +**Correct code**: Instead, always use a literal string using a replacement with the user input: + </div> + <div class="panel-body"> ````javascript function onMessage(server, channel, origin, message) { - server.message(channel, Irccd.Util.format("%{red}#{message}%{}", { message: message }); + server.message(channel, Irccd.Util.format("@{red}#{message}@{}", { message: message }); } ```` + </div> +</div>
--- a/doc/html/api/module/Irccd.Util/function/splithost.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Util/function/splithost.md Thu Feb 11 22:02:57 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" -returns: "the hostname." + - "user, the user to split." +returns: "The hostname." ---
--- a/doc/html/api/module/Irccd.Util/function/splituser.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd.Util/function/splituser.md Thu Feb 11 22:02:57 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" -returns: "the nickname" + - "user, the user to split." +returns: "The nickname." ---
--- a/doc/html/api/module/Irccd/index.md Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/api/module/Irccd/index.md Thu Feb 11 22:02:57 2016 +0100 @@ -21,8 +21,9 @@ var Logger = Irccd.Logger; function onLoad() +{ Logger.info("Major: " + Irccd.version.major); Logger.info("Minor: " + Irccd.version.minor); Logger.info("Patch: " + Irccd.version.patch); -end +} ````
--- a/doc/html/resources/template.html Wed Feb 10 14:18:15 2016 +0100 +++ b/doc/html/resources/template.html Thu Feb 11 22:02:57 2016 +0100 @@ -181,6 +181,16 @@ <p>$returns$</p> $endif$ <!-- endif returns --> + <!-- Throws --> +$if(throws)$ + <h2>Throws</h2> + <ul> +$for(throws)$ + <li>$throws$</li> +$endfor$ + </ul> +$endif$ <!-- endif throws --> + $body$ <!-- !Body --> </div><!-- !table-responsive -->