added doc for elements

src/elements/element.typ

@@ -16,6 +16,33 @@
   return ({}, tl, tr, br, bl)
 }
 
+/// Draws an element
+/// - draw-shape (function): Draw function
+/// - x (number, dictionary): The x position (bottom-left corner).
+///
+///   If it is a dictionary, it should be in the format `(rel: number, to: str)`, where `rel` is the offset and `to` the base anchor
+/// - y (number, dictionary): The y position (bottom-left corner).
+///
+///   If it is a dictionary, it should be in the format `(from: str, to: str)`, where `from` is the base anchor and `to` is the id of the port to align with the anchor
+/// - w (number): Width of the element
+/// - h (number): Height of the element
+/// - name (none, str): Optional name of the block
+/// - name-anchor (str): Anchor for the optional name
+/// - ports (dictionary): Dictionary of ports. The keys are cardinal directions ("north", "east", "south" and/or "west"). The values are arrays of ports (dictionaries) with the following fields:
+///   - `id` (`str`): (Required) Port id
+///   - `name` (`str`): Optional name displayed *in* the block
+///   - `clock` (`bool`): Whether it is a clock port (triangle symbol)
+///   - `vertical` (`bool`): Whether the name should be drawn vertically
+/// - ports-margins (dictionary): Dictionary of ports margins (used with automatic port placement). They keys are cardinal directions ("north", "east", "south", "west"). The values are tuples of (<start>, <end>) margins (numbers)
+/// - fill (none, color): Fill color
+/// - stroke (stroke): Border stroke
+/// - id (str): The block id (for future reference)
+/// - auto-ports (bool): Whether to use auto port placements or not. If false, `draw-shape` is responsible for adding the appropiate ports
+/// - ports-y (array): Array of the ports y offsets (used with `auto-ports: false`)
+/// - debug (dictionary): Dictionary of debug options.
+///
+///   Supported fields include:
+///     - `ports`: if true, shows dots on all ports of the element
 #let elmt(
   draw-shape: default-draw-shape,
   x: none,