Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
hasumikin committed Oct 3, 2024
1 parent be9f4fd commit 491e160
Show file tree
Hide file tree
Showing 21 changed files with 386 additions and 25 deletions.
58 changes: 53 additions & 5 deletions _data/sidebars/picoruby_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ entries:
url: "/Exception.html"
output: web pdf
type: homepage
- title: class GPIO
url: "/GPIO.html"
output: web pdf
type: homepage
- title: class IOError
url: "/IOError.html"
output: web pdf
Expand Down Expand Up @@ -207,10 +211,6 @@ entries:
url: "/ADC.html"
output: web pdf
type: homepage
- title: class GPIO
url: "/GPIO.html"
output: web pdf
type: homepage
- title: class I2C
url: "/I2C.html"
output: web pdf
Expand Down Expand Up @@ -338,6 +338,10 @@ entries:
url: "/File_Stat.html"
output: web pdf
type: homepage
- title: class GPIO::Error
url: "/GPIO_Error.html"
output: web pdf
type: homepage
- title: class IIRFilter
url: "/IIRFilter.html"
output: web pdf
Expand All @@ -358,14 +362,38 @@ entries:
url: "/JSON_Digger.html"
output: web pdf
type: homepage
- title: class JSON::DiggerError
url: "/JSON_DiggerError.html"
output: web pdf
type: homepage
- title: class JSON::Generator
url: "/JSON_Generator.html"
output: web pdf
type: homepage
- title: class JSON::GeneratorError
url: "/JSON_GeneratorError.html"
output: web pdf
type: homepage
- title: class JSON::JSONError
url: "/JSON_JSONError.html"
output: web pdf
type: homepage
- title: class JSON::Parser
url: "/JSON_Parser.html"
output: web pdf
type: homepage
- title: class JSON::ParserError
url: "/JSON_ParserError.html"
output: web pdf
type: homepage
- title: module JWT
url: "/JWT.html"
output: web pdf
type: homepage
- title: class JWT::VerificationError
url: "/JWT_VerificationError.html"
output: web pdf
type: homepage
- title: class MML
url: "/MML.html"
output: web pdf
Expand All @@ -374,7 +402,7 @@ entries:
url: "/Machine.html"
output: web pdf
type: homepage
- title: class MbedTLS
- title: module MbedTLS
url: "/MbedTLS.html"
output: web pdf
type: homepage
Expand All @@ -390,6 +418,10 @@ entries:
url: "/MbedTLS_Digest.html"
output: web pdf
type: homepage
- title: class MbedTLS::HMAC
url: "/MbedTLS_HMAC.html"
output: web pdf
type: homepage
- title: class Module
url: "/Module.html"
output: web pdf
Expand Down Expand Up @@ -418,10 +450,22 @@ entries:
url: "/Net_TCPClient.html"
output: web pdf
type: homepage
- title: class PicoLine
url: "/PicoLine.html"
output: web pdf
type: homepage
- title: class PicoLine::Question
url: "/PicoLine_Question.html"
output: web pdf
type: homepage
- title: class PicoRubyVM
url: "/PicoRubyVM.html"
output: web pdf
type: homepage
- title: class PicoRubyVM::InstructionSequence
url: "/PicoRubyVM_InstructionSequence.html"
output: web pdf
type: homepage
- title: class Prism
url: "/Prism.html"
output: web pdf
Expand Down Expand Up @@ -514,6 +558,10 @@ entries:
url: "/Watchdog.html"
output: web pdf
type: homepage
- title: module YAML
url: "/YAML.html"
output: web pdf
type: homepage
- title: PRK Firmware
output: web pdf
folderitems:
Expand Down
10 changes: 10 additions & 0 deletions pages/rbs_doc/Base64.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,13 @@ Base64.decode64(String) -> String
```ruby
Base64.encode64(String) -> String
```
### urlsafe_decode64

```ruby
Base64.urlsafe_decode64(String) -> String
```
### urlsafe_encode64

```ruby
Base64.urlsafe_encode64(String) -> String
```
5 changes: 5 additions & 0 deletions pages/rbs_doc/Editor_Base.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ Editor::Base.new-> void
```ruby
instance.clear-> untyped
```
### clear_buffer

```ruby
instance.clear_buffer-> void
```
### debug

```ruby
Expand Down
15 changes: 15 additions & 0 deletions pages/rbs_doc/GPIO_Error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: class GPIO::Error
keywords: GPIO::Error
tags: [class]
summary: GPIO::Error class of PicoRuby
sidebar: picoruby_sidebar
permalink: GPIO_Error.html
folder: rbs_doc
---
## Singleton methods
### peripheral_error

```ruby
GPIO::Error.peripheral_error(Integer code, ?String name) -> Integer
```
5 changes: 5 additions & 0 deletions pages/rbs_doc/IO.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ IO.getc-> String?
```ruby
IO.getch-> String
```
### gets

```ruby
IO.gets-> String
```
### raw

```ruby
Expand Down
6 changes: 0 additions & 6 deletions pages/rbs_doc/IOError.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,3 @@ sidebar: picoruby_sidebar
permalink: IOError.html
folder: rbs_doc
---
## Singleton methods
### peripheral_error

```ruby
IOError.peripheral_error(Integer code, ?String name) -> Integer
```
9 changes: 9 additions & 0 deletions pages/rbs_doc/JSON_DiggerError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: class JSON::DiggerError
keywords: JSON::DiggerError
tags: [class]
summary: JSON::DiggerError class of PicoRuby
sidebar: picoruby_sidebar
permalink: JSON_DiggerError.html
folder: rbs_doc
---
9 changes: 9 additions & 0 deletions pages/rbs_doc/JSON_GeneratorError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: class JSON::GeneratorError
keywords: JSON::GeneratorError
tags: [class]
summary: JSON::GeneratorError class of PicoRuby
sidebar: picoruby_sidebar
permalink: JSON_GeneratorError.html
folder: rbs_doc
---
9 changes: 9 additions & 0 deletions pages/rbs_doc/JSON_JSONError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: class JSON::JSONError
keywords: JSON::JSONError
tags: [class]
summary: JSON::JSONError class of PicoRuby
sidebar: picoruby_sidebar
permalink: JSON_JSONError.html
folder: rbs_doc
---
9 changes: 9 additions & 0 deletions pages/rbs_doc/JSON_ParserError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: class JSON::ParserError
keywords: JSON::ParserError
tags: [class]
summary: JSON::ParserError class of PicoRuby
sidebar: picoruby_sidebar
permalink: JSON_ParserError.html
folder: rbs_doc
---
20 changes: 20 additions & 0 deletions pages/rbs_doc/JWT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: module JWT
keywords: JWT
tags: [module]
summary: JWT module of PicoRuby
sidebar: picoruby_sidebar
permalink: JWT.html
folder: rbs_doc
---
## Singleton methods
### decode

```ruby
JWT.decode(String token, ?String|nil secret, ?bool validate) -> [Object, Hash[String, Object]]
```
### encode

```ruby
JWT.encode(String payload, ?String|nil secret, ?String algorithm) -> String
```
9 changes: 9 additions & 0 deletions pages/rbs_doc/JWT_VerificationError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: class JWT::VerificationError
keywords: JWT::VerificationError
tags: [class]
summary: JWT::VerificationError class of PicoRuby
sidebar: picoruby_sidebar
permalink: JWT_VerificationError.html
folder: rbs_doc
---
6 changes: 3 additions & 3 deletions pages/rbs_doc/MbedTLS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: class MbedTLS
title: module MbedTLS
keywords: MbedTLS
tags: [class]
summary: MbedTLS class of PicoRuby
tags: [module]
summary: MbedTLS module of PicoRuby
sidebar: picoruby_sidebar
permalink: MbedTLS.html
folder: rbs_doc
Expand Down
41 changes: 41 additions & 0 deletions pages/rbs_doc/MbedTLS_HMAC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: class MbedTLS::HMAC
keywords: MbedTLS::HMAC
tags: [class]
summary: MbedTLS::HMAC class of PicoRuby
sidebar: picoruby_sidebar
permalink: MbedTLS_HMAC.html
folder: rbs_doc
---
## Singleton methods
### new

```ruby
MbedTLS::HMAC.new(String key, String digest) -> MbedTLS::HMAC
```
## Instance methods
### digest

```ruby
instance.digest() -> String
```
### hexdigest

```ruby
instance.hexdigest() -> String
```
### reset

```ruby
instance.reset() -> MbedTLS::HMAC
```
### update

```ruby
instance.update(String) -> MbedTLS::HMAC
```
## Attr accessors
### _digest (accessor)
```ruby
instance._digest -> String
```
20 changes: 20 additions & 0 deletions pages/rbs_doc/PicoLine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: class PicoLine
keywords: PicoLine
tags: [class]
summary: PicoLine class of PicoRuby
sidebar: picoruby_sidebar
permalink: PicoLine.html
folder: rbs_doc
---
## Instance methods
### ask

```ruby
instance.ask(String) ?{ (Question) -> void } -> String
```
## Attr accessors
### default (accessor)
```ruby
instance.default -> String?
```
18 changes: 18 additions & 0 deletions pages/rbs_doc/PicoLine_Question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: class PicoLine::Question
keywords: PicoLine::Question
tags: [class]
summary: PicoLine::Question class of PicoRuby
sidebar: picoruby_sidebar
permalink: PicoLine_Question.html
folder: rbs_doc
---
## Attr accessors
### default (accessor)
```ruby
instance.default -> String
```
### default_hint_show (accessor)
```ruby
instance.default_hint_show -> bool
```
16 changes: 15 additions & 1 deletion pages/rbs_doc/PicoRubyVM.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,23 @@ sidebar: picoruby_sidebar
permalink: PicoRubyVM.html
folder: rbs_doc
---
## Type aliases
### alloc_stat_t
```ruby
{total: Integer, used: Integer, free: Integer, frag: Integer}
```
### alloc_prof_t
```ruby
{peak: Integer, valley: Integer}
```
## Singleton methods
### memory_statistics

```ruby
PicoRubyVM.memory_statistics-> Hash[Symbol, Integer]
PicoRubyVM.memory_statistics-> alloc_stat_t
```
### profile_alloc

```ruby
PicoRubyVM.profile_alloc() {() -> untyped} -> untyped
```
Loading

0 comments on commit 491e160

Please sign in to comment.