v0.10.4

README.md

@@ -44,6 +44,41 @@ frontends.
 * Created a (re)formatted output of VHDL.
 
 
+## Examples
+### List all Entities with Generics and Ports
+
+The following tiny example is based on GHDL's [`pyGHDL.dom`](https://github.com/ghdl/ghdl/tree/master/pyGHDL/dom) package implementing
+pyVHDLModel.
+
+```python
+from pathlib import Path
+from pyGHDL.dom.NonStandard import Design, Document
+
+sourceFile = Path("example.vhdl")
+
+design = Design()
+library = Design.GetLibrary("lib")
+document = Document(sourceFile)
+design.AddDocument(document, library)
+
+for entity in document.Entities:
+  print("{}".format(entity.Name))
+  print("  generics:")
+  for generic in entity.Generics:
+    print("  - {} : {!s} {}".format(
+      generic.Name, generic.Mode, generic.SubTypeIndication)
+    )
+  print("  ports:")
+  for port in entity.Ports:
+    print("  - {} : {!s} {}".format(
+      port.Name, port.Mode, port.SubTypeIndication)
+    )
+```
+
+
+
+
+
 ## Contributors
 * [Patrick Lehmann](https://github.com/Paebbels) (Maintainer)
 * [Unai Martinez-Corral](https://github.com/umarcor)

doc/LanguageModel/DesignUnits.rst

@@ -83,7 +83,7 @@ types). An entity's list of statements is called body items.
      def LibraryReferences(self) -> List[Library]:
 
      @property
-     def PackageReferences(self) -> List[UseStatement]:
+     def PackageReferences(self) -> List[UseClause]:
 
      @property
      def ContextReferences(self) -> List[Context]:
@@ -131,7 +131,7 @@ Package
      def LibraryReferences(self) -> List[Library]:
 
      @property
-     def PackageReferences(self) -> List[UseStatement]:
+     def PackageReferences(self) -> List[UseClause]:
 
      @property
      def ContextReferences(self) -> List[Context]:
@@ -178,7 +178,7 @@ Architeture
      def LibraryReferences(self) -> List[Library]:
 
      @property
-     def PackageReferences(self) -> List[UseStatement]:
+     def PackageReferences(self) -> List[UseClause]:
 
      @property
      def ContextReferences(self) -> List[Context]:
@@ -223,7 +223,7 @@ Package Body
      def LibraryReferences(self) -> List[Library]:
 
      @property
-     def PackageReferences(self) -> List[UseStatement]:
+     def PackageReferences(self) -> List[UseClause]:
 
      @property
      def ContextReferences(self) -> List[Context]:

doc/conf.py

@@ -37,7 +37,7 @@ def _LatestTagName():
 
 # The full version, including alpha/beta/rc tags
 version = "0.9"     # The short X.Y version.
-release = "0.10.3"   # The full version, including alpha/beta/rc tags.
+release = "0.10.4"   # The full version, including alpha/beta/rc tags.
 try:
 	if _IsUnderGitControl:
 		latestTagName = _LatestTagName()[1:]		# remove prefix "v"