Mercurial > irccd
changeset 27:12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 20 Feb 2016 10:35:43 +0100 |
parents | cdc91b663087 |
children | 9a907e58f978 |
files | doc/html/api/module/Irccd.File/function/exists.md doc/html/api/module/Irccd.File/function/remove.md doc/html/api/module/Irccd.File/function/stat.md doc/html/api/module/Irccd.File/method/constructor.md doc/html/api/module/Irccd.File/method/read.md doc/html/api/module/Irccd.File/method/readline.md doc/html/api/module/Irccd.File/method/remove.md doc/html/api/module/Irccd.File/method/seek.md doc/html/api/module/Irccd.File/method/stat.md doc/html/api/module/Irccd.File/method/tell.md doc/html/api/module/Irccd.File/method/write.md doc/html/api/module/Irccd.System/function/popen.md |
diffstat | 12 files changed, 30 insertions(+), 29 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/api/module/Irccd.File/function/exists.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/exists.md Sat Feb 20 10:35:43 2016 +0100 @@ -5,5 +5,5 @@ arguments: - "**path**: the path to the file." returns: "True if exists." -throws: "Any exception if we don't have access." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.File/function/remove.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/remove.md Sat Feb 20 10:35:43 2016 +0100 @@ -4,5 +4,5 @@ synopsis: "Irccd.File.remove(path)" arguments: - "**path**: the path to the file." -throws: "Any exception on error." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.File/function/stat.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/function/stat.md Sat Feb 20 10:35:43 2016 +0100 @@ -1,29 +1,30 @@ --- function: stat -summary: "Get file information at the specified path." +summary: > + Get file information at the specified path. + + The returned object may have the following properties if they are available on your system: + + - **atime**: (int) the last access time, + - **blksize**: (int) the block size, + - **blocks**: (int) the number of blocks, + - **ctime**: (int) the creation time, + - **dev**: (int) the device, + - **gid**: (int) the group, + - **ino**: (int) the inode, + - **mode**: (int) the mode, + - **mtime**: (int) the modification time, + - **nlink**: (int) the number of hard links, + - **rdev**: (int), + - **size**: (int) the file size, + - **uid**: (int) the user. synopsis: "info = Irccd.File.stat(path)" arguments: - "**path**: the path to the file." returns: "The stat information." -throws: "Any exception on error." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." --- -The returned object may have the following properties if they are available on your system: - - - **atime**: (int) the last access time, - - **blksize**: (int) the block size, - - **blocks**: (int) the number of blocks, - - **ctime**: (int) the creation time, - - **dev**: (int) the device, - - **gid**: (int) the group, - - **ino**: (int) the inode, - - **mode**: (int) the mode, - - **mtime**: (int) the modification time, - - **nlink**: (int) the number of hard links, - - **rdev**: (int), - - **size**: (int) the file size, - - **uid**: (int) the user. - ## Remarks <div class="alert alert-warning" role="alert">
--- a/doc/html/api/module/Irccd.File/method/constructor.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/constructor.md Sat Feb 20 10:35:43 2016 +0100 @@ -5,7 +5,7 @@ arguments: - "**path**: the path to the file," - "**mode**: the mode string." -throws: "Any exception on error." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." --- ## Mode
--- a/doc/html/api/module/Irccd.File/method/read.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/read.md Sat Feb 20 10:35:43 2016 +0100 @@ -5,5 +5,5 @@ arguments: - "**amount**: the amount of characters or -1 to read all (Optional, default: -1)." returns: "The string." -throws: "Any exception on error." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.File/method/readline.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/readline.md Sat Feb 20 10:35:43 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: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.File/method/remove.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/remove.md Sat Feb 20 10:35:43 2016 +0100 @@ -2,5 +2,5 @@ method: remove summary: "Synonym of File.remove(path) but with the path from the file." synopsis: "File.prototype.remove()" -throws: "Any exception on error" +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.File/method/seek.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/seek.md Sat Feb 20 10:35:43 2016 +0100 @@ -5,5 +5,5 @@ arguments: - "**type**: the type of setting (`Irccd.File.SeekSet`, `Irccd.File.SeekCur`, `Irccd.File.SeekSet`)," - "**amount**: the new offset." -throws: "Any exception on error." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.File/method/stat.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/stat.md Sat Feb 20 10:35:43 2016 +0100 @@ -3,7 +3,7 @@ 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." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." --- ## Remarks
--- a/doc/html/api/module/Irccd.File/method/tell.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/tell.md Sat Feb 20 10:35:43 2016 +0100 @@ -3,5 +3,5 @@ summary: "Get the actual position in the file." synopsis: "pos = File.prototype.tell()" returns: "The position." -throws: "Any exception on error." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.File/method/write.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/write.md Sat Feb 20 10:35:43 2016 +0100 @@ -4,5 +4,5 @@ synopsis: "File.prototype.write(data)" arguments: - "**data**: the character to write." -throws: "Any exception on error." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." ---
--- a/doc/html/api/module/Irccd.System/function/popen.md Tue Feb 16 13:58:52 2016 +0100 +++ b/doc/html/api/module/Irccd.System/function/popen.md Sat Feb 20 10:35:43 2016 +0100 @@ -6,7 +6,7 @@ - "**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." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." --- ## Remarks