aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/libghdl
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@plc2.de>2021-01-04 15:19:37 +0100
committertgingold <tgingold@users.noreply.github.com>2021-01-05 18:50:44 +0100
commitef5f93a9d726c7c68899beb276c0b7f3f446c196 (patch)
treeef90a9270c7f75ea854a3820fcc087e2dae88f06 /pyGHDL/libghdl
parente60be77e4f3cbccf67761a3c169799ff59b7086f (diff)
downloadghdl-ef5f93a9d726c7c68899beb276c0b7f3f446c196.tar.gz
ghdl-ef5f93a9d726c7c68899beb276c0b7f3f446c196.tar.bz2
ghdl-ef5f93a9d726c7c68899beb276c0b7f3f446c196.zip
Fixed parameter reference.
Diffstat (limited to 'pyGHDL/libghdl')
-rw-r--r--pyGHDL/libghdl/__init__.py6
-rw-r--r--pyGHDL/libghdl/utils/__init__.py26
2 files changed, 16 insertions, 16 deletions
diff --git a/pyGHDL/libghdl/__init__.py b/pyGHDL/libghdl/__init__.py
index 1f24ab631..2d7791b51 100644
--- a/pyGHDL/libghdl/__init__.py
+++ b/pyGHDL/libghdl/__init__.py
@@ -56,7 +56,7 @@ def _get_libghdl_name() -> Path:
def _check_libghdl_libdir(libdir: Path, basename: Path) -> Path:
- """Returns libghdl path in :param:`libdir`, if found."""
+ """Returns libghdl path in :obj:`libdir`, if found."""
if libdir is None:
raise ValueError("Parameter 'libdir' is None.")
# print('libghdl: check in {}'.format(libdir))
@@ -160,7 +160,7 @@ def initialize() -> None:
@export
def set_option(opt: bytes) -> bool:
- """Set option :param:`opt`. Return true, if the option is known and handled."""
+ """Set option :obj:`opt`. Return true, if the option is known and handled."""
return libghdl.libghdl__set_option(*_to_char_p(opt)) == 0
@@ -181,7 +181,7 @@ def analyze_init_status() -> int:
@export
def analyze_file(fname: bytes):
- """"Analyze a given filename :param:`fname`."""
+ """"Analyze a given filename :obj:`fname`."""
return libghdl.libghdl__analyze_file(*_to_char_p(fname))
diff --git a/pyGHDL/libghdl/utils/__init__.py b/pyGHDL/libghdl/utils/__init__.py
index 127878a6b..a98b6c963 100644
--- a/pyGHDL/libghdl/utils/__init__.py
+++ b/pyGHDL/libghdl/utils/__init__.py
@@ -47,7 +47,7 @@ import pyGHDL.libghdl.vhdl.flists as flists
@export
def name_image(nameid) -> str:
- """Lookup a :param:`nameid` and return its string."""
+ """Lookup a :obj:`nameid` and return its string."""
return name_table.Get_Name_Ptr(nameid).decode("utf-8")
@@ -65,7 +65,7 @@ _fields_image = _build_enum_image(nodes_meta.fields)
@export
def fields_image(idx) -> str:
- """String representation of field :param:`idx`."""
+ """String representation of field :obj:`idx`."""
return _fields_image[idx]
@@ -74,7 +74,7 @@ _kind_image = _build_enum_image(nodes.Iir_Kind)
@export
def kind_image(k) -> str:
- """String representation of Iir_Kind :param:`k`."""
+ """String representation of Iir_Kind :obj:`k`."""
return _kind_image[k]
@@ -83,7 +83,7 @@ _types_image = _build_enum_image(nodes_meta.types)
@export
def types_image(t) -> str:
- """String representation of Nodes_Meta.Types :param:`t`."""
+ """String representation of Nodes_Meta.Types :obj:`t`."""
return _types_image[t]
@@ -92,7 +92,7 @@ _attr_image = _build_enum_image(nodes_meta.Attr)
@export
def attr_image(a) -> str:
- """String representation of Nodes_Meta.Attr :param:`a`."""
+ """String representation of Nodes_Meta.Attr :obj:`a`."""
return _attr_image[a]
@@ -110,7 +110,7 @@ def leftest_location(n):
@export
def fields_iter(n) -> Generator[Any, None, None]:
- """Iterate on fields of node :param:`n`."""
+ """Iterate on fields of node :obj:`n`."""
if n == nodes.Null_Iir:
return
k = nodes.Get_Kind(n)
@@ -122,7 +122,7 @@ def fields_iter(n) -> Generator[Any, None, None]:
@export
def chain_iter(n) -> Generator[Any, None, None]:
- """Iterate of a chain headed by node :param:`n`."""
+ """Iterate of a chain headed by node :obj:`n`."""
while n != nodes.Null_Iir:
yield n
n = nodes.Get_Chain(n)
@@ -130,14 +130,14 @@ def chain_iter(n) -> Generator[Any, None, None]:
@export
def chain_to_list(n) -> List[Any]:
- """Convert a chain headed by node :param:`n` to a Python list."""
+ """Convert a chain headed by node :obj:`n` to a Python list."""
return [e for e in chain_iter(n)]
@export
def nodes_iter(n) -> Generator[Any, None, None]:
"""
- Iterate all nodes of :param:`n`, including :param:`n`.
+ Iterate all nodes of :obj:`n`, including :obj:`n`.
Nodes are returned only once.
"""
if n == nodes.Null_Iir:
@@ -179,7 +179,7 @@ def nodes_iter(n) -> Generator[Any, None, None]:
@export
def list_iter(lst) -> Generator[Any, None, None]:
- """Iterate all element of Iir_List :param:`lst`."""
+ """Iterate all element of Iir_List :obj:`lst`."""
if lst <= nodes.Iir_List_All:
return
iter = lists.Iterate(lst)
@@ -190,7 +190,7 @@ def list_iter(lst) -> Generator[Any, None, None]:
@export
def flist_iter(lst) -> Generator[Any, None, None]:
- """Iterate all element of Iir_List :param:`lst`."""
+ """Iterate all element of Iir_List :obj:`lst`."""
if lst <= nodes.Iir_Flist_All:
return
for i in range(flists.Flast(lst) + 1):
@@ -199,7 +199,7 @@ def flist_iter(lst) -> Generator[Any, None, None]:
@export
def declarations_iter(n) -> Generator[Any, None, None]:
- """Iterate all declarations in node :param:`n`."""
+ """Iterate all declarations in node :obj:`n`."""
k = nodes.Get_Kind(n)
if nodes_meta.Has_Generic_Chain(k):
for n1 in chain_iter(nodes.Get_Generic_Chain(n)):
@@ -317,7 +317,7 @@ def declarations_iter(n) -> Generator[Any, None, None]:
@export
def concurrent_stmts_iter(n) -> Generator[Any, None, None]:
- """Iterate concurrent statements in node :param:`n`."""
+ """Iterate concurrent statements in node :obj:`n`."""
k = nodes.Get_Kind(n)
if k == nodes.Iir_Kind.Design_File:
for n1 in chain_iter(nodes.Get_First_Design_Unit(n)):