HEL/circuiteria
4
5
Fork 5
Code Issues 6 Pull Requests 1 Releases 2 Activity

improved doc + moved examples to separate file

Browse Source
This commit is contained in:
Louis Heredero
2024-05-17 16:52:43 +02:00
parent ccc38c3e1d
commit 4d97062d30
10 changed files with 192 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/elements/alu.typ
View File

@@ -39,14 +39,7 @@
/// Draws an ALU with two inputs
///
/// #box(width: 100%, align(center)[
/// #circuit({
/// element.alu(x: 0, y: 0, w: 1, h: 2, id: "alu")
/// wire.stub("alu-port-in1", "west")
/// wire.stub("alu-port-in2", "west")
/// wire.stub("alu-port-out", "east")
/// })
/// ])
/// #examples.alu
/// - x (number, dictionary): see `elmt()`
/// - y (number, dictionary): see `elmt()`
/// - w (number): see `elmt()`

28
src/elements/block.typ
View File

@@ -15,37 +15,15 @@
/// Draws a block element
///
/// #box(width: 100%, align(center)[
/// #circuit({
/// element.block(
/// x: 0, y: 0,
/// w: 2, h: 2,
/// id: "block",
/// ports: (
/// north: ((id: "clk", clock: true),),
/// west: (
/// (id: "in1", name: "A"),
/// (id: "in2", name: "B"),
/// ),
/// east: (
/// (id: "out", name: "C"),
/// )
/// )
/// )
/// wire.stub("block-port-clk", "north")
/// wire.stub("block-port-in1", "west")
/// wire.stub("block-port-in2", "west")
/// wire.stub("block-port-out", "east")
/// })
/// ])
/// #examples.block
/// - x (number, dictionary): see `elmt()`
/// - y (number, dictionary): see `elmt()`
/// - w (number): see `elmt()`
/// - h (number): see `elmt()`
/// - name (none, str): see `elmt()`
/// - name-anchor (str): see `elmt()`
/// - ports: (dictionary): see `elmt()`
/// - ports-margins: (dictionary): see `elmt()`
/// - ports (dictionary): see `elmt()`
/// - ports-margins (dictionary): see `elmt()`
/// - fill (none, color): see `elmt()`
/// - stroke (stroke): see `elmt()`
/// - id (str): see `elmt()`

12
src/elements/extender.typ
View File

@@ -27,17 +27,7 @@
/// Draws a bit extender
///
/// #box(width: 100%, align(center)[
/// #circuit({
/// element.extender(
/// x: 0, y: 0,
/// w: 3, h: 1,
/// id: "extender"
/// )
/// wire.stub("extender-port-in", "west")
/// wire.stub("extender-port-out", "east")
/// })
/// ])
/// #examples.extender
/// - x (number, dictionary): see `elmt()`
/// - y (number, dictionary): see `elmt()`
/// - w (number): see `elmt()`

27
src/elements/multiplexer.typ
View File

@@ -23,32 +23,7 @@
/// Draws a multiplexer
///
/// #box(width: 100%, align(center)[
/// #circuit({
/// element.multiplexer(
/// x: 0, y: 0,
/// w: 1, h: 3,
/// id: "multiplexer",
/// entries: 3
/// )
/// wire.stub("multiplexer-port-in0", "west")
/// wire.stub("multiplexer-port-in1", "west")
/// wire.stub("multiplexer-port-in2", "west")
/// wire.stub("multiplexer.north", "north")
/// wire.stub("multiplexer-port-out", "east")
/// element.multiplexer(
/// x: 3, y: 0,
/// w: 1, h: 3,
/// id: "multiplexer2",
/// entries: ("A", "B", "C")
/// )
/// wire.stub("multiplexer2-port-in0", "west")
/// wire.stub("multiplexer2-port-in1", "west")
/// wire.stub("multiplexer2-port-in2", "west")
/// wire.stub("multiplexer2.south", "south")
/// wire.stub("multiplexer2-port-out", "east")
/// })
/// ])
/// #examples.multiplexer
/// - x (number, dictionary): see `elmt()`
/// - y (number, dictionary): see `elmt()`
/// - w (number): see `elmt()`