diff options
| author | D. Shah <dave@ds0.me> | 2021-01-29 13:03:11 +0000 |
|---|---|---|
| committer | D. Shah <dave@ds0.me> | 2021-02-02 17:00:14 +0000 |
| commit | 9614d3722929f99520c6b83600641c14ef37188b (patch) | |
| tree | 9dd6511215993c7b7131403f6f43569e6ce9d56a /docs | |
| parent | 9388df19d3ab3ca1b127defafe6fa3f71147f451 (diff) | |
| download | nextpnr-9614d3722929f99520c6b83600641c14ef37188b.tar.gz nextpnr-9614d3722929f99520c6b83600641c14ef37188b.tar.bz2 nextpnr-9614d3722929f99520c6b83600641c14ef37188b.zip | |
docs: Update archapi.md with IdStringList
Signed-off-by: D. Shah <dave@ds0.me>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/archapi.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/archapi.md b/docs/archapi.md index 6b9b0913..e3c06efd 100644 --- a/docs/archapi.md +++ b/docs/archapi.md @@ -106,11 +106,11 @@ Get list of cell types that this architecture accepts. Bel Methods ----------- -### BelId getBelByName(IdString name) const +### BelId getBelByName(IdStringList name) const -Lookup a bel by its name. +Lookup a bel by its name, which is a list of IdStrings joined by `getNameDelimiter()`. -### IdString getBelName(BelId bel) const +### IdStringList getBelName(BelId bel) const Get the name for a bel. (Bel names must be unique.) @@ -186,11 +186,11 @@ Return a list of all pins on that bel. Wire Methods ------------ -### WireId getWireByName(IdString name) const +### WireId getWireByName(IdStringList name) const -Lookup a wire by its name. +Lookup a wire by its name, which is a list of IdStrings joined by `getNameDelimiter()`. -### IdString getWireName(WireId wire) const +### IdStringList getWireName(WireId wire) const Get the name for a wire. (Wire names must be unique.) @@ -262,11 +262,11 @@ of the bounds is almost always better than an under-estimate. Pip Methods ----------- -### PipId getPipByName(IdString name) const +### PipId getPipByName(IdStringList name) const -Lookup a pip by its name. +Lookup a pip by its name, which is a list of IdStrings joined by `getNameDelimiter()`. -### IdString getPipName(PipId pip) const +### IdStringList getPipName(PipId pip) const Get the name for a pip. (Pip names must be unique.) @@ -353,11 +353,11 @@ Get all pips uphill of a wire, i.e. pips that use this wire as destination wire. Group Methods ------------- -### GroupId getGroupByName(IdString name) const +### GroupId getGroupByName(IdStringList name) const -Lookup a group by its name. +Lookup a group by its name, which is a list of IdStrings joined by `getNameDelimiter()`. -### IdString getGroupName(GroupId group) const +### IdStringList getGroupName(GroupId group) const Get the name for a group. (Group names must be unique.) |