Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
hasumikin committed Oct 22, 2024
1 parent 19e839b commit 89a2ac4
Show file tree
Hide file tree
Showing 21 changed files with 587 additions and 129 deletions.
20 changes: 20 additions & 0 deletions _data/sidebars/picoruby_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ entries:
url: "/NoMethodError.html"
output: web pdf
type: homepage
- title: class NotImplementedError
url: "/NotImplementedError.html"
output: web pdf
type: homepage
- title: class Prism::ParseError
url: "/Prism_ParseError.html"
output: web pdf
Expand Down Expand Up @@ -338,6 +342,10 @@ entries:
url: "/Dir.html"
output: web pdf
type: homepage
- title: class EOFError
url: "/EOFError.html"
output: web pdf
type: homepage
- title: module Editor
url: "/Editor.html"
output: web pdf
Expand Down Expand Up @@ -382,10 +390,18 @@ entries:
url: "/File.html"
output: web pdf
type: homepage
- title: module File::Constants
url: "/File_Constants.html"
output: web pdf
type: homepage
- title: class File::Stat
url: "/File_Stat.html"
output: web pdf
type: homepage
- title: class FileTest
url: "/FileTest.html"
output: web pdf
type: homepage
- title: class IIRFilter
url: "/IIRFilter.html"
output: web pdf
Expand Down Expand Up @@ -490,6 +506,10 @@ entries:
url: "/Net_UDPClient.html"
output: web pdf
type: homepage
- title: class Object
url: "/Object.html"
output: web pdf
type: homepage
- title: class PicoLine
url: "/PicoLine.html"
output: web pdf
Expand Down
61 changes: 38 additions & 23 deletions pages/rbs_doc/Dir.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,37 @@ sidebar: picoruby_sidebar
permalink: Dir.html
folder: rbs_doc
---
## Type aliases
### path_t
```ruby
String
```
## Singleton methods
### chdir

```ruby
Dir.chdir(?path dir) -> 0
Dir.chdir[U] (?path dir) { (String dir) -> U } -> U
Dir.chdir(?path_t dir) -> 0
Dir.chdir[U] (?path_t dir) { (path_t dir) -> U } -> U
```
### delete

```ruby
Dir.delete(path dirname) -> 0
Dir.delete(path_t dirname) -> 0
```
### empty?
### entries

```ruby
Dir.empty?(path path_name) -> bool
Dir.entries(String dir) -> Array[String]
```
### exist?

```ruby
Dir.exist?(path) -> bool
Dir.exist?(path_t dirname) -> bool
```
### foreach

```ruby
Dir.foreach(String path) { (String path) -> untyped } -> nil
```
### getwd

Expand All @@ -37,24 +47,19 @@ Dir.getwd() -> String
### glob

```ruby
Dir.glob(path pattern, ?int flags, ?base: path?) -> Array[String]
Dir.glob(path pattern, ?int flags, ?base: path?) { (String pathname) -> void } -> nil
Dir.glob(path_t pattern, ?int flags, ?base: path?) -> Array[String]
Dir.glob(path_t pattern, ?int flags, ?base: path?) { (String pathname) -> void } -> nil
```
### mkdir

```ruby
Dir.mkdir(path) -> 0
```
### new

```ruby
Dir.new(path dir) -> VFS::dir_t
Dir.mkdir(path_t dirname, ?Integer mode) -> 0
```
### open

```ruby
Dir.open(path dirname) -> VFS::dir_t
Dir.open[U] (path dirname) { (VFS::dir_t) -> U } -> VFS::dir_t
Dir.open(path_t dirname) -> untyped
Dir.open[U] (path_t dirname) { (Dir dir) -> U } -> Dir
```
## Instance methods
### close
Expand All @@ -65,22 +70,22 @@ instance.close() -> nil
### each

```ruby
instance.each() { (String) -> void } -> self
instance.each() { (String item) -> untyped} -> self
```
### findnext
### empty?

```ruby
instance.findnext() -> String?
instance.empty?() -> bool
```
### pat=
### findnext

```ruby
instance.pat=(path) -> path
instance.findnext() -> Dir
```
### path
### pat=

```ruby
instance.path() -> String?
instance.pat=(String) -> String
```
### read

Expand All @@ -92,3 +97,13 @@ instance.read() -> String?
```ruby
instance.rewind() -> self
```
### seek

```ruby
instance.seek(Integer pos) -> 0
```
### tell

```ruby
instance.tell() -> Integer
```
9 changes: 9 additions & 0 deletions pages/rbs_doc/EOFError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: class EOFError
keywords: EOFError
tags: [class]
summary: EOFError class of PicoRuby
sidebar: picoruby_sidebar
permalink: EOFError.html
folder: rbs_doc
---
39 changes: 27 additions & 12 deletions pages/rbs_doc/Editor_Buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,52 +17,67 @@ Editor::Buffer.new() -> instance
### bottom

```ruby
instance.bottom-> void
instance.bottom() -> void
```
### clear

```ruby
instance.clear-> void
instance.clear() -> void
```
### current_char

```ruby
instance.current_char-> String?
instance.current_char() -> String?
```
### current_line

```ruby
instance.current_line-> String
instance.current_line() -> String
```
### current_tail

```ruby
instance.current_tail(?Integer n) -> String
```
### delete

```ruby
instance.delete() -> void
```
### delete_line

```ruby
instance.delete_line() -> (String | nil)
```
### down

```ruby
instance.down-> void
instance.down() -> void
```
### dump

```ruby
instance.dump-> String
instance.dump() -> String
```
### head

```ruby
instance.head-> void
instance.head() -> void
```
### home

```ruby
instance.home-> void
instance.home() -> void
```
### insert_line

```ruby
instance.insert_line(String | nil line) -> void
```
### left

```ruby
instance.left-> void
instance.left() -> void
```
### put

Expand All @@ -72,17 +87,17 @@ instance.put(String | Symbol c) -> void
### right

```ruby
instance.right-> void
instance.right() -> void
```
### tail

```ruby
instance.tail-> void
instance.tail() -> void
```
### up

```ruby
instance.up-> void
instance.up() -> void
```
## Attr accessors
### lines (accessor)
Expand Down
17 changes: 14 additions & 3 deletions pages/rbs_doc/File.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ permalink: File.html
folder: rbs_doc
---
## Singleton methods
### basename

```ruby
File.basename(String filename) -> String
```
### chmod

```ruby
Expand All @@ -33,16 +38,22 @@ File.expand_path(string, ?string) -> String
```ruby
File.file?(string) -> bool
```
### join

```ruby
File.join(*String parts) -> String
```
### new

```ruby
File.new(string, ?string mode) -> VFS::file_t
File.new(string fd_or_path, ?string mode, ?int perm) -> File
File.new[T] (string fd_or_path, ?string mode, ?int perm) { (untyped) -> T } -> untyped
```
### open

```ruby
File.open(string, ?string) -> VFS::file_t
File.open[T] (string, ?string) { (VFS::file_t) -> T } -> untyped
File.open(string, ?string) -> File
File.open[T] (string, ?string) { (untyped) -> T } -> untyped
```
### rename

Expand Down
55 changes: 55 additions & 0 deletions pages/rbs_doc/FileTest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: class FileTest
keywords: FileTest
tags: [class]
summary: FileTest class of PicoRuby
sidebar: picoruby_sidebar
permalink: FileTest.html
folder: rbs_doc
---
## Singleton methods
### directory?

```ruby
FileTest.directory?(String file) -> bool
```
### exist?

```ruby
FileTest.exist?(String file) -> bool
```
### file?

```ruby
FileTest.file?(String file) -> bool
```
### pipe?

```ruby
FileTest.pipe?(String file) -> bool
```
### size

```ruby
FileTest.size(String |nil file) -> Integer
```
### size?

```ruby
FileTest.size?(String file) -> (Integer | nil)
```
### socket?

```ruby
FileTest.socket?(String file) -> bool
```
### symlink?

```ruby
FileTest.symlink?(String file) -> bool
```
### zero?

```ruby
FileTest.zero?(String file) -> bool
```
9 changes: 9 additions & 0 deletions pages/rbs_doc/File_Constants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: module File::Constants
keywords: File::Constants
tags: [module]
summary: File::Constants module of PicoRuby
sidebar: picoruby_sidebar
permalink: File_Constants.html
folder: rbs_doc
---
Loading

0 comments on commit 89a2ac4

Please sign in to comment.