Skip to content

Commit

Permalink
docs: hide private modules
Browse files Browse the repository at this point in the history
  • Loading branch information
RoyalIcing committed Jun 18, 2024
1 parent 980f0ef commit 39440da
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 1 deletion.
1 change: 1 addition & 0 deletions lib/orb/block.ex
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ defmodule Orb.Block do
end

defmodule Branch do
@moduledoc false
defstruct [:identifier, :if]

defimpl Orb.ToWat do
Expand Down
2 changes: 2 additions & 0 deletions lib/orb/control/return.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
defmodule Orb.Control.Return do
@moduledoc false

defstruct body: :unset, push_type: nil

def new(), do: %__MODULE__{body: nil}
Expand Down
6 changes: 6 additions & 0 deletions lib/orb/effect.ex
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
defmodule Orb.Effect do
@moduledoc false
defstruct stack_pop: nil, stack_push: nil, memory: nil, global: nil, extern: nil

defmodule StackPop do
@moduledoc false
end

defmodule StackPush do
@moduledoc false
end

defmodule MemoryWrite do
@moduledoc false
end

defmodule GlobalWrite do
@moduledoc false
end

defmodule ExternUnknown do
@moduledoc false
end
end
3 changes: 3 additions & 0 deletions lib/orb/global.ex
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,10 @@ defmodule Orb.Global do
end

defmodule Declare do
@moduledoc false

defmodule DeclareDSL do
@moduledoc false
import Kernel, except: [@: 1]

defmacro register_global(name, value) do
Expand Down
3 changes: 3 additions & 0 deletions lib/orb/import.ex
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ defmodule Orb.Import do
end

defmodule DSL do
@doc """
Declare the name and signature of function that will be imported.
"""
defmacro defw(call, result_type \\ nil) do
alias Elixir.Orb.{Func, Import}

Expand Down
2 changes: 2 additions & 0 deletions lib/orb/leb.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
defmodule Orb.Leb do
@moduledoc false

def uleb128(0), do: [0]
def uleb128(n), do: uleb128(n, [])

Expand Down
2 changes: 1 addition & 1 deletion lib/orb/memory.ex
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
defmodule Orb.Memory do
@moduledoc """
Work with memory.
Work with memory: load, store, declare pages & initial data.
"""

defstruct name: "", min: 0, exported?: false
Expand Down
4 changes: 4 additions & 0 deletions lib/orb/stack.ex
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ defmodule Orb.Stack do
"""

defmodule Drop do
@moduledoc false

defstruct instruction: nil, count: 0, pop_type: nil, push_type: nil

require alias Orb.Ops
Expand Down Expand Up @@ -50,6 +52,8 @@ defmodule Orb.Stack do
end

defmodule Pop do
@moduledoc false

defstruct pop_type: nil, push_type: nil, count: 0

require alias Orb.Ops
Expand Down
2 changes: 2 additions & 0 deletions lib/orb/table.ex
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ defmodule Orb.Table do
# end

defmodule CallIndirect do
@moduledoc false

defstruct pop_type: nil,
push_type: nil,
type_signature: nil,
Expand Down
2 changes: 2 additions & 0 deletions lib/orb/to_wasm.ex
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ defprotocol Orb.ToWasm do
end

defmodule Orb.ToWasm.Helpers do
@moduledoc false

import Orb.Leb

def sized(bytes) do
Expand Down

0 comments on commit 39440da

Please sign in to comment.